From 96bce712f456c5e5877d2078a8f804dfe88012d3 Mon Sep 17 00:00:00 2001 From: Tony Date: Mon, 16 Mar 2026 22:17:05 +1300 Subject: [PATCH 1/2] feat: add lambda container image support Signed-off-by: Tony --- README.md | 78 ++++++++- docs/assets/hierarchy.js | 2 +- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/classes/ApiApp.html | 4 +- docs/classes/ApiLambdaApp.html | 16 +- docs/classes/ApiRequest.html | 14 +- docs/classes/Server.html | 4 +- docs/classes/_internal_.Agent-1.html | 2 +- docs/classes/_internal_.Agent.html | 2 +- docs/classes/_internal_.Alias.html | 2 +- docs/classes/_internal_.ApiBody.html | 2 +- docs/classes/_internal_.ApiBodyInfo.html | 2 +- docs/classes/_internal_.ApiOperation.html | 2 +- docs/classes/_internal_.ApiOperationInfo.html | 2 +- docs/classes/_internal_.ApiParam.html | 2 +- docs/classes/_internal_.AsyncResource.html | 2 +- docs/classes/_internal_.ClientRequest.html | 2 +- docs/classes/_internal_.Collection.html | 2 +- docs/classes/_internal_.Document.html | 2 +- ...ventEmitter.EventEmitterAsyncResource.html | 2 +- docs/classes/_internal_.EventEmitter.html | 2 +- docs/classes/_internal_.HttpRequest.html | 2 +- docs/classes/_internal_.HttpResponse.html | 2 +- docs/classes/_internal_.IncomingMessage.html | 2 +- docs/classes/_internal_.NodeBase.html | 2 +- docs/classes/_internal_.OutgoingMessage.html | 2 +- docs/classes/_internal_.Readable.html | 2 +- docs/classes/_internal_.Scalar.html | 2 +- docs/classes/_internal_.Socket.html | 2 +- docs/classes/_internal_.Stream.Duplex.html | 2 +- .../_internal_.Stream.PassThrough.html | 2 +- docs/classes/_internal_.Stream.Transform.html | 2 +- docs/classes/_internal_.Stream.Writable.html | 2 +- docs/classes/_internal_.Stream.html | 2 +- docs/classes/_internal_.URL.html | 2 +- docs/classes/_internal_.YAMLError.html | 2 +- docs/classes/_internal_.YAMLMap.html | 2 +- docs/classes/_internal_.YAMLSeq.html | 2 +- docs/classes/_internal_.YAMLWarning.html | 2 +- docs/hierarchy.html | 2 +- docs/index.html | 58 ++++++- docs/interfaces/_internal_.ALBEvent.html | 10 ++ .../_internal_.ALBEventHeaders.html | 1 + .../_internal_.ALBEventMultiValueHeaders.html | 1 + ...BEventMultiValueQueryStringParameters.html | 1 + ...ternal_.ALBEventQueryStringParameters.html | 1 + .../_internal_.ALBEventRequestContext.html | 2 + docs/interfaces/_internal_.AbortSignal-2.html | 2 +- docs/interfaces/_internal_.AbortSignal.html | 2 +- .../_internal_.AddEventListenerOptions.html | 2 +- docs/interfaces/_internal_.AddOperation.html | 2 +- .../interfaces/_internal_.AgentOptions-1.html | 2 +- docs/interfaces/_internal_.AgentOptions.html | 2 +- docs/interfaces/_internal_.ArrayIterator.html | 2 +- .../interfaces/_internal_.AsyncGenerator.html | 2 +- .../_internal_.AsyncIterableIterator.html | 2 +- docs/interfaces/_internal_.AsyncIterator.html | 2 +- .../_internal_.AsyncResourceOptions.html | 2 +- .../_internal_.AwsCredentialIdentity.html | 2 +- ...rnal_.AwsRegionExtensionConfiguration.html | 2 +- ...internal_.AwsSdkSigV4AAuthInputConfig.html | 2 +- ..._internal_.AwsSdkSigV4AuthInputConfig.html | 2 +- ...pleResolvedValueMetadataInjectOptions.html | 2 +- docs/interfaces/_internal_.BaseOperation.html | 2 +- ...nalResolvedValueMetadataInjectOptions.html | 2 +- .../_internal_.BaseParameterObject.html | 2 +- ...aseResolvedValueMetadataInjectOptions.html | 2 +- .../_internal_.BindInFluentSyntax.html | 2 +- .../_internal_.BindInWhenOnFluentSyntax.html | 2 +- .../_internal_.BindOnFluentSyntax.html | 2 +- .../_internal_.BindWhenFluentSyntax.html | 2 +- .../_internal_.BindWhenOnFluentSyntax.html | 2 +- .../_internal_.BoundServiceSyntax.html | 2 +- .../interfaces/_internal_.CallbackObject.html | 2 +- .../_internal_.CallbacksObject.html | 2 +- .../_internal_.ChecksumConfiguration.html | 2 +- .../interfaces/_internal_.ClientDefaults.html | 2 +- .../interfaces/_internal_.ClientProtocol.html | 2 +- .../_internal_.ClientRequestArgs.html | 2 +- docs/interfaces/_internal_.Codec.html | 2 +- docs/interfaces/_internal_.CollectionTag.html | 2 +- .../_internal_.CommonConnectionOptions.html | 2 +- .../_internal_.ComponentsObject.html | 2 +- .../_internal_.ConfigurableSerdeContext.html | 2 +- .../_internal_.ConnectionOptions.html | 2 +- docs/interfaces/_internal_.ContactObject.html | 2 +- docs/interfaces/_internal_.Context.html | 2 +- docs/interfaces/_internal_.CopyOperation.html | 2 +- ...ternal_.DefaultExtensionConfiguration.html | 2 +- .../_internal_.DeserializeHandlerOutput.html | 2 +- .../_internal_.DetailedPeerCertificate.html | 2 +- docs/interfaces/_internal_.Dict.html | 2 +- .../_internal_.Document.Parsed.html | 2 +- .../interfaces/_internal_.EncodingObject.html | 2 +- .../_internal_.EndpointParameters.html | 2 +- .../interfaces/_internal_.ErrnoException.html | 2 +- docs/interfaces/_internal_.Event.html | 2 +- .../_internal_.EventEmitter.Abortable.html | 2 +- ...tter.EventEmitterAsyncResourceOptions.html | 2 +- ....EventEmitterReferencingAsyncResource.html | 2 +- ...nternal_.EventEmitter.NodeEventTarget.html | 2 +- docs/interfaces/_internal_.EventEmitter.html | 2 +- .../_internal_.EventEmitterOptions.html | 2 +- .../_internal_.EventListenerOptions-1.html | 2 +- .../_internal_.EventListenerOptions.html | 2 +- docs/interfaces/_internal_.EventTarget.html | 2 +- ...internal_.ExternalDocumentationObject.html | 2 +- .../_internal_.FinalizeHandlerArguments.html | 2 +- .../_internal_.FinalizeHandlerOutput.html | 2 +- docs/interfaces/_internal_.Generator.html | 2 +- docs/interfaces/_internal_.GetAllOptions.html | 2 +- docs/interfaces/_internal_.GetOperation.html | 2 +- docs/interfaces/_internal_.GetOptions.html | 2 +- docs/interfaces/_internal_.HeaderObject.html | 2 +- docs/interfaces/_internal_.Headers.html | 2 +- ...ernal_.HttpAuthExtensionConfiguration.html | 2 +- .../_internal_.HttpAuthSchemeInputConfig.html | 2 +- .../_internal_.HttpAuthSchemeParameters.html | 2 +- .../_internal_.HttpAuthSchemeProvider.html | 2 +- ...al_.HttpHandlerExtensionConfiguration.html | 2 +- docs/interfaces/_internal_.HttpMessage.html | 2 +- docs/interfaces/_internal_.HttpRequest.html | 2 +- docs/interfaces/_internal_.HttpResponse.html | 2 +- docs/interfaces/_internal_.Identity.html | 2 +- .../_internal_.IncomingHttpHeaders.html | 2 +- docs/interfaces/_internal_.InfoObject.html | 2 +- ..._internal_.InitializeHandlerArguments.html | 2 +- .../_internal_.InitializeHandlerOutput.html | 2 +- docs/interfaces/_internal_.LicenseObject.html | 2 +- docs/interfaces/_internal_.LinkObject.html | 2 +- docs/interfaces/_internal_.ListSchema.html | 2 +- docs/interfaces/_internal_.MapSchema.html | 2 +- .../_internal_.MediaTypeObject.html | 2 +- docs/interfaces/_internal_.MoveOperation.html | 2 +- ...nalResolvedValueMetadataInjectOptions.html | 2 +- ...pleResolvedValueMetadataInjectOptions.html | 2 +- .../_internal_.OAuthFlowObject.html | 2 +- .../_internal_.OAuthFlowsObject.html | 2 +- docs/interfaces/_internal_.OpenAPIObject.html | 2 +- .../_internal_.OperationObject.html | 2 +- .../_internal_.OptionalGetOptions.html | 2 +- ...nalResolvedValueMetadataInjectOptions.html | 2 +- .../_internal_.OutgoingHttpHeaders.html | 2 +- .../_internal_.ParameterObject.html | 2 +- docs/interfaces/_internal_.Parsed-1.html | 2 +- docs/interfaces/_internal_.Parsed-2.html | 2 +- docs/interfaces/_internal_.Parsed-3.html | 2 +- docs/interfaces/_internal_.Parsed.html | 2 +- .../interfaces/_internal_.PathItemObject.html | 2 +- docs/interfaces/_internal_.PathsObject.html | 2 +- .../_internal_.PeerCertificate.html | 2 +- docs/interfaces/_internal_.ProcessEnv.html | 2 +- docs/interfaces/_internal_.ProxyEnv.html | 2 +- .../_internal_.ReadWriteStream.html | 2 +- .../interfaces/_internal_.ReadableStream.html | 2 +- ...internal_.ReadableStreamAsyncIterator.html | 2 +- .../_internal_.ReadableStreamBYOBReader.html | 2 +- ...internal_.ReadableStreamDefaultReader.html | 2 +- ...internal_.ReadableStreamGenericReader.html | 2 +- .../_internal_.RemoveOperation.html | 2 +- .../_internal_.ReplaceOperation.html | 2 +- .../_internal_.RequestBodyObject.html | 2 +- .../_internal_.RequestOptions-1.html | 2 +- .../interfaces/_internal_.RequestOptions.html | 2 +- .../_internal_.RequestSigningArguments.html | 2 +- .../interfaces/_internal_.ResponseObject.html | 2 +- .../_internal_.ResponsesObject.html | 2 +- ..._internal_.RetryStrategyConfiguration.html | 2 +- .../interfaces/_internal_.S3ClientConfig.html | 2 +- .../_internal_.S3ExpressIdentity.html | 2 +- .../_internal_.S3ExtensionConfiguration.html | 2 +- ..._internal_.S3HttpAuthSchemeParameters.html | 2 +- .../_internal_.S3HttpAuthSchemeProvider.html | 2 +- docs/interfaces/_internal_.ScalarTag.html | 2 +- docs/interfaces/_internal_.SchemaObject.html | 2 +- docs/interfaces/_internal_.ScopesObject.html | 2 +- .../_internal_.SecureContextOptions.html | 2 +- .../_internal_.SecuritySchemeObject.html | 2 +- .../_internal_.SerializeHandlerArguments.html | 2 +- docs/interfaces/_internal_.ServerObject.html | 2 +- .../_internal_.ServerVariableObject.html | 2 +- .../_internal_.ShapeDeserializer.html | 2 +- .../_internal_.ShapeSerializer.html | 2 +- .../_internal_.SigningArguments.html | 2 +- .../_internal_.SpecIterableIterator.html | 2 +- docs/interfaces/_internal_.SpecIterator.html | 2 +- ...al_.StaticEventEmitterIteratorOptions.html | 2 +- .../_internal_.StaticEventEmitterOptions.html | 2 +- .../_internal_.Stream.DuplexOptions.html | 2 +- .../_internal_.Stream.FinishedOptions.html | 2 +- .../_internal_.Stream.ReadableOptions.html | 2 +- .../_internal_.Stream.StreamOptions.html | 2 +- .../_internal_.Stream.TransformOptions.html | 2 +- .../_internal_.Stream.WritableOptions.html | 2 +- ....node_stream_promises.FinishedOptions.html | 2 +- .../_internal_.StructureSchema.html | 2 +- docs/interfaces/_internal_.TagBase.html | 2 +- docs/interfaces/_internal_.TagObject.html | 2 +- docs/interfaces/_internal_.TestOperation.html | 2 +- docs/interfaces/_internal_.TraitsSchema.html | 2 +- docs/interfaces/_internal_.URL.html | 2 +- .../_internal_.URLSearchParamsIterator.html | 2 +- .../interfaces/_internal_.WritableStream.html | 2 +- docs/interfaces/_internal_.XmlObject.html | 2 +- ...internal_._S3HttpAuthSchemeParameters.html | 2 +- docs/modules.html | 2 +- docs/modules/_internal_.html | 2 +- docs/types/LambdaApiHandler.html | 2 + docs/types/LambdaApiRequest.html | 2 + docs/types/NativeApiRequest.html | 2 + docs/types/_internal_.Callback.html | 15 ++ docs/types/_internal_.Handler.html | 35 ++++ docs/types/_internal_.URI.html | 2 +- src/ApiApp.ts | 4 +- src/ApiLambdaApp.ts | 17 +- src/api/Server.ts | 8 +- src/api/reflection/ControllerLoader.ts | 55 +++++- src/model/ApiRequest.ts | 22 +++ src/ts-lambda-api.ts | 1 + tests/src/ApiAcceptanceTests.ts | 42 +++++ tests/src/ApiLambdaAppTests.ts | 156 ++++++++++++++++++ tests/src/OpenApiTests.ts | 2 +- .../nested/NestedController.ts | 12 ++ 224 files changed, 719 insertions(+), 240 deletions(-) create mode 100644 docs/interfaces/_internal_.ALBEvent.html create mode 100644 docs/interfaces/_internal_.ALBEventHeaders.html create mode 100644 docs/interfaces/_internal_.ALBEventMultiValueHeaders.html create mode 100644 docs/interfaces/_internal_.ALBEventMultiValueQueryStringParameters.html create mode 100644 docs/interfaces/_internal_.ALBEventQueryStringParameters.html create mode 100644 docs/interfaces/_internal_.ALBEventRequestContext.html create mode 100644 docs/types/LambdaApiHandler.html create mode 100644 docs/types/LambdaApiRequest.html create mode 100644 docs/types/NativeApiRequest.html create mode 100644 docs/types/_internal_.Callback.html create mode 100644 docs/types/_internal_.Handler.html create mode 100644 tests/src/test-controllers/nested/NestedController.ts diff --git a/README.md b/README.md index 3961b70e..cdc47342 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,7 @@ This project is built on top of the wonderful [lambda-api](https://github.com/je - [Creating a new API](#create-api) - [Deploy to AWS Lambda](#aws-deploy) - [Invoke AWS Lambda](#invoke-lambda) + - [Deploy as Lambda Container Image](#deploy-as-lambda-container-image) **Docs** @@ -38,6 +39,7 @@ This project is built on top of the wonderful [lambda-api](https://github.com/je - [Creating a new API](#creating-a-new-api) - [Deploy to AWS Lambda](#deploy-to-aws-lambda) - [Invoke Lambda](#invoke-lambda) + - [Deploy as Lambda Container Image](#deploy-as-lambda-container-image) - [Routing](#routing) - [Controller Routes](#controller-routes) - [Endpoint Routes](#endpoint-routes) @@ -150,9 +152,7 @@ appConfig.version = "v1" const controllersPath = [path.join(__dirname, "controllers")] const app = new ApiLambdaApp(controllersPath, appConfig) -export async function handler(event, context) { - return await app.run(event, context) -} +export const handler = app.createHandler() ``` - Add a `src/controllers` directory @@ -197,6 +197,8 @@ npm run tsc ***Note**: AWS supplies the `aws-sdk` package at runtime when running your Lambda applications, so there is no need to include this in your deployment package.* +`ts-lambda-api` supports the standard Lambda HTTP event formats for API Gateway and ALB when deployed as either a `.zip` package or a Lambda container image. Container images do not change the proxy event or response contract, they only change how your function code is packaged and started. + - Build your application - Remove dev dependencies from your `node_modules` directory: @@ -235,6 +237,68 @@ wget -qO - https://some.alb.dns.address/api/v1/hello-world/ {"hello":"world"} ``` +### Deploy as Lambda Container Image + + +AWS Lambda container images are a first-class deployment package type. The same `ApiLambdaApp` handler can be used for API Gateway or ALB whether you deploy a `.zip` archive or a container image. + +#### Container image requirements + +- Lambda container images must be Linux based. +- Build each image for exactly one architecture (`linux/amd64` or `linux/arm64`). +- Lambda runs the image on a read-only filesystem. Only `/tmp` is writable at runtime. +- The default Lambda user must be able to read all files needed to start the function. +- If you use an AWS Lambda base image, you do not need to add a `USER` instruction. +- If you use a non-AWS or OS-only base image, you must include the runtime interface client (`aws-lambda-ric` for Node.js). + +#### AWS Node.js base image example + +```dockerfile +FROM public.ecr.aws/lambda/nodejs:22 + +WORKDIR ${LAMBDA_TASK_ROOT} + +COPY package.json yarn.lock ./ +RUN yarn install --production --frozen-lockfile + +COPY dist ./dist + +CMD ["dist/api.handler"] +``` + +Build the image with `buildx` and disable provenance metadata so the image is accepted by Lambda: + +```shell +docker buildx build --platform linux/amd64 --provenance=false -t ts-lambda-api-app:latest . +``` + +AWS supports overriding the Dockerfile `ENTRYPOINT`, `CMD`, and working directory with Lambda `ImageConfig` if you need to change them without rebuilding the image. + +#### Non-AWS base image example + +```dockerfile +FROM node:22-bookworm-slim + +ENV NPM_CONFIG_CACHE=/tmp/.npm + +WORKDIR /function + +COPY package.json yarn.lock ./ +RUN yarn install --production --frozen-lockfile +RUN yarn add aws-lambda-ric + +COPY dist ./dist + +ENTRYPOINT ["/usr/local/bin/npx", "aws-lambda-ric"] +CMD ["dist/api.handler"] +``` + +#### Local workflow notes + +- Docker and the `buildx` plugin are required for the current AWS container image workflow. +- Current AWS Node.js image guidance uses `docker buildx build ... --provenance=false`. +- Modern Docker releases are required for current Lambda base images and local container testing. + ## Routing @@ -332,13 +396,15 @@ The default IOC app `Container` enables the `autobind` option. Controllers decor initialization. However, controllers can be explicitly specified instead of relying on the `@injectable` decoration to dynamically load the controllers from a directory. +When `autobind` is enabled, the loader scans each configured controller root recursively and imports `.js`, `.cjs` and `.mjs` files. In a compiled Lambda deployment you can usually pass just the top-level controllers directory. + Create an IOC `Container` without the `autobind` option. Bind the desired controller classes to the container and pass the instance into the `ApiLambdaApp` constructor. The `controllersPath` parameter is ignored when the custom container's `autobind` option disabled. ```typescript import { Container } from 'inversify'; -import { ApiLambdaApp, ApiRequest, AppConfig } from 'ts-lambda-api'; +import { ApiLambdaApp, AppConfig } from 'ts-lambda-api'; import { AppController } from './controllers/AppController'; const appConfig = new AppConfig(); @@ -353,9 +419,7 @@ appContainer.bind(AppController).toConstantValue(appController); // Pass the customer container into the app - controllersPath is ignored (false signals that autobind is not turned on) const app = new ApiLambdaApp(undefined, appConfig, false, appContainer); -export const lambdaHandler = async (event: ApiRequest, context: any) => { - return await app.run(event, context); -}; +export const lambdaHandler = app.createHandler(); ``` **Note you do not need to decorate controller classes with `@injectable` when autobind is disabled** diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index a2f22e89..494b5ba9 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJy1XO9v2zYT/l/8md3EH5LIfEvTdgvQrEXcrhiGolAlxtFbWXIluWs29H9/cZTsiLJk8+j0SxIEvHseHskj747Uf4u6qtpmcfG3YgEjlFAqGKE0ooQyIWNCOQ9C+ClCQlkUcqICGRAVRDGhgquYcB5QQoUIOKEslhGRQgaECqookZxxaGYUCR4SGQaUyACgGGOKUBYoUCwjox3+EYeSSCHgz4gJInnICY8UkYIaSClIrHhEKKchJ5TGilCqQIvgDJhwrgBeBKAsAiqKU/MzIjKIOZFKCkKFDAWhrG+n6EeyqPVdodM2r8pmcfHfgsKPMlnrxcXicpNfbjYLsviSl9nigjJJFtu6WFws0iJpGt382rX45b5dFwvS/XdxsWib7BmIPOv+QRbpfV5ktS4XF39z+fEHWXBpw7xO1p+z5DTYvt0JSICI1ADj+nLb3r/Ki1bXewgWRjuIvGx1fZekuvl10HIWZN983Le461w8QH6eNHk6gT7RwVHT030UQWDZcXNVlXf56rgR+0antcOysIfpeZU9HFP+yRimTIpPv/StMVOD0jAgNAr4RwMe2n3L3yZ1snZHN81dOhmNpvybja4TWA/uWHsRVHcjpbqexsOZ+mbTrcXjs3SA3wtgJ6sIAoPOJD1AT4rfdOtJZCjrwKmjEA0o+ECjIO1RYBLcvqKdMRS1mVwWhQ+ZRzFHE0QBP1xq1+VdhVtuIOEw5yOlZuY8DtISc8CV1MLNssO1dtK6QylH40omBrC3el190x7II0Fn8NgC3xRJ6oduS7rC86EPv/Hr+Y1Pv/lwUV9VmwcPYEvMFVgMN453umk9gC0xZ+Bw7MbQuEMpV9hw6LOe52V2XX641+Wb8lWx1WW7fCjb5Ls7hTkNjnSUiEZ0ziXjRcV28jI0/p2FglqLMcmSz4V2dHi75phNPuSMERpwxczJkPKhM7gqcl22b+uqrdKqQKwKS85tXDiNhzvM7227udVft7pp3XEHQvhtlga0M4EMD3g0m6psNJZIJ+XBhAnDhEVDJksOWuH0vUzv9Vq/ratveXYyXBiwmtPgOEAssoKif5qrWme6bPOkuDa/2wfELjkljjWVFLE5i0O0a0c0PpuIJYZfwVQR2MjhR0xgW4MfEQF3Dz/Cnig/8IXneMGncDqcW6ceUHyONzzTEyoRdaR4MOGmz3PST0Is4sMhXKZJkdTvkhViGe5EHNddZCUKrqqiT4egQC0xR+BYiZEnfPQd1+Vm246ieSe3OKnCkZC05sTlSpetaywAbTH7ogioSQTB73Mwn1GHLAmVfIyBDuqGUkdALYMKLobA729fu+O9v33tCmIlMJZtrZ3TJF1jzLjBCYqIWEkCJxszgiHl8/hih76usm2BQgeFzWbXy0iKAxT0IPaIljQ6bxIHkohYdJ2PAzlxoPQlNpJ3orYt869b/Uey1m+TWpcmrw1j8tE+h7JQdIStnN6HOm/PITySx9rykZWSE6xws3gnhT+e85AZZwR0BjRebDeF/u5rGksaa5iIBsYwwO+AEc4snQzGKBGVgigRmvwgMBmG03VSNndV7b32xgrcnBxQmmKBM8VeDGUNFZk0LfweUHibNM27+7raru5xJAaCp7euOLZm5Ku8zJt7nfkafyT/hP6FhjQ257dYWtvBzqONtgWHbNdQDrt8zC5FGePmAA6Vs2EpqNW15V1OktlJeISasZk7UPwbMHj5TZfty3Xenq5GDVgMpbBMYFSIpDyCSibrKMX2tp20eTqE8JhjMyrQYWegeEdRHadoxqWtnoLqSJWbVwKDTmxb2Lluy+HPI0o+znXJYuucxF9+b3XZ5FXZRQJbbNQ+p8HRQpxxK7jqNUBvdZ3pq6ps9XdECmpOA7pUS3kMlfoYKu5QumdRVwKC/1mMM51i6GU6dTVNOE7I3eimSVbIPFgv5JWQI5AVJJCS67oupb3ZJEX+r/49KbNC15f1ars2/t+Z3pwGVwMpNk/nzbbdbBETZ1LckYigwymBT8b55t8gJWgGRlhz8iDPCJVu3eoa4wFndbjaRKjZ5AU+deqdOB3bq5vIIrJrbiZlvcxXZV6uPObxjAJXS9kbLX/5fVPrpsFPowNRVwLSSvVV2zJb6vpbnmp0ou9AFj1EPOAEMqIEMpBmsEIrufyiSo11HQ/Vu+aYE72MAnNUlVEQHkM+lrs4iWtlLwDRih3qRmfuZt+DdYLex3bosOl4zM+h48zCQMXx2VCu+TYpA3U+GHMEU9a89QTjrmB2/JusoJqCKGd3AujVGnG4h9gFwFJZSZouze4a+5rGqEUax+YyHVy6tMtiy+zLMl/9KWC/8EqTz+tA2ydWoiNpudghwJOwfDqaJ8PQ4+PoFINO3vrkAYFMNVGMGx+kmLV8Jrkcc8BOTCwnDJd9h4P0uapbXB7AwtzLe7tjMIGdRYEsN4GcT28hMWOhW32na12mcBppHsr0VjfVtk59u+Ki2s1PKWaVkIaKLW3oiH2W75RaZ66hC1efpTGr7HTKDxKvQzdbpV+062moa+xwES+wY6vrMq3WebkaB6DH0UZSLndtAzo0eXePZXwN5TioJeMCKe1tuq6+P7wsvyE26l7C8foTlRE7jD3Q892Wc8VWfJRtKbuaNBr+QBSdlaKyv8at1HDI32pdX+m6ze/yNGkRDmskiE53CBr3952DyKoGZ5lZrK/zptWlR9pzRoHr1edAHTghbyqePEZ5oSDqRg4SRCdujB1fqi7XxR4XKlzLOnUxzAXvxK2wIaB1UXRYnT+Oc6w0P3XVgYudQa2L/u9vXy91Uqf3JvfSuIMPpVz6yZia2efO2oY9JxgcETpzMD6+jAmZcK9S0UAQXYPu7zFQJkLrdjps27vKz648gHALU+KuTkFYL4geVXkycEMeuQERdq9TWEjj0TA9Fiue//XmOfwHk+ub0+BqnJDP83mh75Jt0Z5HyVLiyio68F59pvncAsxJVejyGotFN7KR9Qyv7/a5fI+qOYOrVS25/Ke51au8Ks9le0LROXyn8uNPMRnm9ZzB1spfLO+TDVTXclMxwdyAtgWd14716sooeaEbX/yhqCuD2Noi9z3wL33NqkCPEZeyG6PYOtxfl3mbn1MQm1GA56f67TMOhyfZT09RpTqiBH+XncU7nnJiZfqTfCqGxoI9xchajt6FK4+K1cho0c5o1luJm23R5ptCQ1aj+KazP5Niq290m2RJm1yX/9MpPuJ11+m8qGM2wXn3SvVncHfX7dwHyzH/DO4/g7P1AixpnnSeuOnzWHwRfJMhjpn5okMfosTWzvTX5c3rl3VduWbL9+1Rz8KZZLuX2SwYoX9IaljQCPxewiVOlNbVYBC+SY5+kGEEdZOgvgQB1br+0bWQI+Cl/ooAXuqvKGDVPUWjPBDDQ/tlkSeuYbhpi6tn8agDpdZJ9o8q01Yt7zjurjmuv3BDDDpLKGe08+jwx+SzF9c87F4AObnhUysw4h0LbpXgffLumPT6KBHR3bE233mZI4FPB/rVI6ZTJJxHwjrzdQl3ExKa6BRBbELY0aHDR2yGcWKeIo6Z0BrtjKHf8PEc+P6OCGS/cIQ1TG+27aryNcaEsKsxQiYnWOAqJyMp3EdSAtqdEsEwdmUj1U2DrW30MughgrpKR8NOoy51uq13tzLxF3MnpD2oRfA5J8V5TzAOrDRHm+SFzrwrETMKHOcPfCLK8rvrtYni/Ss1kwrwRtubi7OpN/Jdauw3qCzk6Xn5NUsJ/qAWwiexIAvY0+XKotvWD8u2Tlq9evBMsszrwJONuu9dmU94HYvePYK7eR0eh1+mdjRja600ozwGNsswp8GD4n5+qtHntfTPCEdxes8IN7pOCfvhunkq//SxHk6vR6es6EkINdygxpv0iWLeiV35MW4RofUBlOVGn1G2mZJ29ewyHL1Ry9vGJIUSxEW9gRS+xi3hY4JCRuZLf329G/45oAXlYSypRxlnU1jn1ptkg4XcizgjWpv8sq23abutNRZ3JOiKrvjcFPSbevihF6o7JQv7sdteqd8q8Kkcwno0VOBJ4BM+XiyrTH9qzN+fNnW1zhvdeLxo/PHjx/8BTBUXxA==" \ No newline at end of file +window.hierarchyData = "eJy1XN1y2zYTfRddIy3xQxLwnfPXeiZuMlbSTKeTyTAkLPMLRSokldrt5N2/WZKSAYqUsJBzI3lk7J6DBbDA7oL8b1FXVdssLv5WTMSEEkrhi0YRoSzkjFDOwwA+VUAoi5QkirKQKEoZoUIIRjiPefenJJRJTokMWUioYDwikkcS/tcpEjIgMhQRkQFgMBYLQhkVoJ5SQlkcwA8y4EQKBX9GkSKSK0l4TIkUUQfJFImVpCCkJKFUQssAtAgOtAWHXwSVYacMqKgYfgchSakkKmCKUCGVAvy+HY8+kUWtbwudtnlVNouL/xYUPspkrRcXi8tNfrnZLMjia15miwvKJFls62JxsUiLpGl082vf4pe7dl0sSP/r4mLRNtkzEHnW/0AW6V1eZLUuFxd/c/npB1lwacO8SdZfsuQ02L7dCUiAiM2uXF1u27vXedHqeg/BwmgHkZetrm+TVDe/Gi1nQfbNx31TfeeUgfw8afJ0An2ig6Omp/soAmbZcfOiKm/z1XEjDo1Oa4dlYQ/T8yp7OKb8c2eYMik+/zK0xkwNSsOQ0IhFnzrwMLTB3yV1snZH75q7dDKKbJy3G10nsB7csfYiqO7GjPU9lcJg8HbTr8Xjs9TAHwSwk1UEPToPogP0pPhNt55ETFkHTh0Fai5VH2gUpD0KPIjArfaTjtPIZnJZFD5kHsUcTRCx6HCpXZW3FW65gYTDnI8Zm5nzOEhLzAFXWea9zLLDtXbSuqaUo3EVM+fXjV5X37UH8kjQGVxY4JsiSf3QbUlneHMzuvbr+bVPvzk3gF9UmwcPYEvMGdjctd7rpvUAtsRcgQUbuzE0rinlDGsepp7nZXZVfrzT5dvydbHVZbt8KNvk3p3CnAY3OiwQfETnXDJeVGwnr0R37GShjKzFmGTJl0I7Orxdc8wmH/IoJjQQPO5OhlSaU+RFkeuyfVdXbZVWBWJVWHJu48IZNafJ7227udHftrpp3XENIfQIMCq6LZYzHhzwaDZV2WgskV7Kg0nUH9M5NZksOWiF0/cyvdNr/a6uvufZyXDBYDWnwXGAODUXzuU/zYtaZ7ps86S46r7bB8QuOSWONZUMaR+t8ZjbEY3PJmKJ4VcwjQhs5PAh4EMR2GLgIybgegei4YEvPMcLPoXT4VzREalzvOF5nhDcc0fKDh13bvY8J/0kxKLY9FPLNCmS+n2yQizDnYjjuoupsA4qxZAOQYFaYo7AkquRJ3z0HVflZtuOonkntzipwpWQtXouV7psXWMBaIvZF0UQdcMN3+dgPqMOWRLG5BgDHdSZUkdALYMKLk3gDzdv3PE+3LxxBBFWAL9sa+2cJukbY8YNTlBESMEJnGy6EQxDOY8vdujrKtsWKHRQ2Gx2vYytOKYXRQ/igGhJo/MmcciJiGXf+TjkEwdKX2IjeSdq2zL/ttV/JGv9Lql12eW1YUw+2edQplRPWJrR0cc6b88hPJLH2nLPSlpBw04rbhbvpPDHcx7GnTMCOgaNl9tNoe99TWNJYw0TUdEZBvgdMMKZpZfBGCViTBElVAgMgIkZTtdJ2dxWtffaGytwc3JAaYoFzhR7MYw14oAKMAR8GxTeJU3z/q6utqs7HAlD8PTWFcfWjHydl3lzpzNf44/kn9C/0JAx2plJWtvBzqONtgWHbJcphz5Mwi4FxbYu5ITKmVkKanVteZeTZHYS+FCTsW7uQPHPYPDquy7bV+u8PV2NMliYUlgmMCpEUkmhktntXFAUtDbUpM1TE8Jjjs2oQIedtC8SwvdRit24tNVTUB2pcvNKYNCJbQs712059HkEDmP7uS45tc5J/NV9q8smr8o+Ethio/Y5DY4W4pG0gqtBA/RW15l+UZWtvkekoOY0oEu1VDIiecygBA+lexbzwYCxlaKrMp1i6GU6dTWNGifkrnXTJCtkHmwQ8krIEcgKEkjJdV0XVsr+dV4mRf6v/j0ps0LXl/Vqu+78vzO9OQ2OBhJWIn+k7O223WwRE2dS3JVIZE4JfDLON/8GKcF+YKw5eZBnhEq3bnWN8YCzOlxtosRs8gKfOvVOnI7t1U/kkDLrDNKlrJf5qszLlcc8nlHgaKnQ3mj5q/tNrZsGP40ORF0JMCspWm3LbKnr73mq0Ym+A1n8EMUhgYwo4cMFBLgdZYY4VdpZ1/FQvWuOOdHLKOyOqjIKg2PIx3IXJ3Gt7AUgWrFD3ejM3ex7sF7Q+9gOHe46Hstz6DizAChpXTXwg3LNt0kZivPBmCOYsuatJxh3A4Pbe2b8m6ygmoIoZ/cC6NUaxd09xC6IUXZlt0+zu8a+XWPUIpX97Si4dGmXxZbZ12W++lPAfuGVJp/Xgb/wx1VP0nKxJsCTsHw6mifD0OPj6BSDTt76jEMCmWqimOx8kGLW8pnkcswBOzGxnDBc9jUH6UtVt7g8gIW5l/d2x2CCT6PcMlz0jfukqGJW5s0Ev9G3utZlCqeR5qFMb3RTbevUtysuqh39FLNKSKZiSxs6Yp/lO6XWlasMXLj6LI1ZZadTfpB4Nd1slX7VrqehvrHDRbzAjq2uyrRa5+VqHIAeRxtJudy1DSLT5P09lvE1lOOglowLpLS36bq6f3hVfkds1IOE420sqoL4MPZAz3dbzhk7HmVbyr4mjYY/EEVnpRjrcnjdUwqm/bWuX+i6zW/zNGkRDmskiE53CEbDnhANrGpwlnWL9U3etLr0SHvOKHAcMngUZOyEvKl48hjnhYJh5Ki1cqZujB1fqi7XxR4XKlzLOnUxzAXvxK0wE1Cajtaszh/HOVaan7rqwOVgUGZdBf5w82apkzq963IvjTu4KeXSTxaLmX3urG3Yc4LBEWEwRzy+jAmZcK9SkSGIrkEP9xgoCwPTTt22vav87MoDCLcwJe7qFELOJpl4MnBDHrmBMBCDWSI2GqbHYsXzv94+h18wub45Dc7GkfN8XurbZFu051GylLiyig6815BpPrcAc1IVurzGqepHNpJmQD90+1y+R9WcwdWqllz+09zoVV6V57I9ocifbxxM5cefYjLM6zmDrZW/WN4lG6iu5V3FBHMD2hZ0XTsxj8boL3Xji2+KOjOwtsh9D/xLX7Mq0GMkOB/GyDrcX5V5m59TEJtR4MFv2D5lYJ5kPz9FleqIEjzPmO148omV6U/yqRh2FtxRtJajd+HKo2I1fgBgZzTrWYnrbdHmm0JDVqP4rrM/k2Krr3WbZEmbXJX/0yk+4nXX6bqoJY0nOO+eUv0Z3N11O/fBcsw/g/tP4Myt5x2S5knniZs+j8VH4WUPksJbGiQbQhRp7Ux/XV6/eVXXlWu2fN8e9Vg4k9EOPQpH6B+TGhY0An+QcIkTpXU1GISvk6MvZBhBXSeoN0FAta7vp1J8BLzU3xDAS/0NBazE8LR3YL2p4bLIE9cwvGuLAo0lHR4xt06yf1SZtmp5x3F3zTHQULgjXWcJ5SwaHvtnkX3Paff8imsedi+AnNwSFphS/aEGXrQyjnSReXdMen2UiOjvWHfveZkjgU8H+tUjplMkXATKOvP1CfcuJOyiUwSxCWHX1zMIq1DyMk8Rx0xojX8ngwhgrgp4/46gfFg4whqmt9t2VfkaY0LY1Rih9SzkThGucjKSwr0kJYj6UyIYxq5spLppsLWNQQY9RFBXGWhYadSlTrf17lYm/mLuhDSemgrgdU4q7tOukPm30hxtkhc6865EzChwnD/wiijL767XXRTvX6mZVOBhtJ25eDT1jHyfGvsNKgt5el5+zVLikZiEV2JBFnCgK+33a7T1w7Ktk1avHjyTLPM68GQj2W908AqvY9G7R3A3rwNPM47FQNPKPBupFM8sw5wGH4rD/BTWazbgMPQzwlGc3jPCjV2n5KhTPyPWw+n16ZQZPYlQmBvUeJM+Ucw7sSs/xi0iVFb6cKPPKNtMSbt6dqlGz6jlbdMlhRLERT1DCl/jVvAyQaHg8CTUUO+GHw1aUB7GknqUcTWFss6t18kGC7kXcUa0NvllW2/TdltrLO5I0Bk9npuCflMPP/ShoMNwW3d790r9VoFP5RDWY0cFHgl8wocXyyrTn5vu78+bulrnjW48nmj88ePH/wEZ0xiw" \ No newline at end of file diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index bc2a1f15..a2127604 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJzFnW1v5DaSx7/KwXsvs5fMQ2Y3weEAP03SG3vccXsmFyyCAS3R3TyrJYVi2+4c9rsfqIdukaLIYhUn92ow7n/Vr0RJFB+L//zfE8Vf1Mn3J/8pSsVlyYr/OvnqpGZqc/L9ybbKdwVvvv48/Pb5PzZqW5x8dfIoyvzk+9dfnWQbUeSSlyff//Pg6rQQrPF6aRWmr7dfnWQFa5qT709Uk/9VNH/lL538xE1ZMtnwHIj5Sz2oe9qr796++cbD/Ndv//rqgLqost2Wl8oLG0SJL6sFPLBsBtbJrdvy7TvghV0+8VJdboVSXHovbiwkXuDY1WmzL7Nb3lQ7mfFjAK1DTwCzLszQXr3+u6ccjqVwel9Jxe4LHip1I4iDVUzhu4veuIabWomqbKJiCTmjh3jLH7jkZSbK9cxNiwxzziEu1A9Vzlvvd0yuuYqKyrKll1Xcm/QXrv/CD6aYCmqVsYL5uZ2E+O6eXd2c//T5/c3VxeXFkab2tZM1Vlul+s13f3v17WtQyXZerhZ3l7enV1BoL8dTl1eniw9hWivDU37+eHN3+fni5uPZ1WUYNlZTmavFhx/gzE5NvYf2c/PEpNAVaNyz84b02ISZzkcHCLWeGh/M8eQAIe6Hxseaf3CikPYzE0a6nhtoUYabd6MqLb59dyTd7WsO5qhOjKqkleRs6ye1EmIlXVY5/75pPX1dy2orGu5vjfdUbfe5s/s82E3b+1GhvBelaDY8B7ZpfIFYrnBf6YfeyTGQh12ZtQ6hcQwuzADewR61WtS8ECUn8AcXEfzfvCUw/0C4LzX6efzcBy8e9p8/w678QDZskZc8LfT5S3aX7p9xyQdyiku+2NUFf/F2qHpsp8T1m5asae42stqtNxDUSI7j3UlWNg+V3EJoBzGO9YsUVpdwHjVokb1PKdk+roIcm+Aqwu62x1ENGxwW9z1IUvUvRR3srA4PqqiR3dBl/xLHXZ9lhUPfcpbrhzAObVnh0J2vOLBhg8Me3vA4sm2Ggw/vfBzbsqI9ZOesKO5Z9ujrxJkP2GBB6Bb3ni54o0TJ9FXA8SOjpBEsFJe6VN/3n1dURLaTpBEuu9YbKUDLBz2+3iE8mN6ATl5ZQ4ch8Mo1Mojmxt8F044eh6MhEwphpjlDosfeBssQH8nBEbwKm5jg6SzP27H7lVh3LXhA69y0QfX98rb5tGRCwpBHPQoX19Ul9WrXXF3wB7Yr1I9ivfmFKS6vmXyEkWeMUYGI5lLKSkIv+iBHwobGE5Q26JG4aZfEj3N3S77ISAViUOKIaiiPz4wxst/86+n11TWrvSMFvebLz16PQbT5a+1pxX8P0lb89z/nsgYQ7bJOi3UlhdpsFyMiL3dbaxHAQWVeHLB7vjYm/h2jAK0C2feHOf/rK6R7cyGGy/10IQbY+XLhd71cIB3X4qzK937nnWYCmLpZlA8VxJXWBdzd1FxaXR63v4MQ6hASpCEOOF4yyfyjZIPI6wi8OiPFIoyd2rwXheIyXBiG1HcFZ0V173WlBbh4z4oqe7wSjf/1PahwkPNC8FLd8t93PAAylEhYVRQ8Cz7fRxkWUyomyvEyCSelVxEh1+0HCIbqtHig1CUTfnxNqe/xvRBSl/QT91fiRxku9unyNhfEubwNirgs87oSpQoWzljoKxr3epvQwjFU7D9ylnPpvwW9BglQqoa84yMdBdTUVdn4X4mxEIdalFm1FeX6mjcNW/tplhYHvGJ/7FdcPomML3JeKvEgAk+G0wIJ14Or1a4MPYwjHQ6k16qdscDdG0Q4xE3NS90m2okiD1yOKSXhfuClbt5UIOBB7KshbnZqXQGfQEuLnQ4V/uinYzlQ19ORBod79/ACHBGugEiVD6jioVU69jJI15StYxkk3P2Gb1nAvZYg3VfZI/ffgE5CcX+a55I3/o+ZoUTCrLVO85PnKPcfb6+8vj/eXqEdrziT2abtHPmLydLigHo0pB2F9KIOKjzEGNaaQUyGtWIAxgDTDGAywBQD+IXJUpTrIKTX4UCfV29040d3Mdt3mbc3lyujAeie4/WY4iZ62xmHH1mZF+PvsBs+1hJo9pyIB+aaCvmyLHsYzKDlvJY8Y4rn/5Ye/Bp5mXnedj/0AIBusgAXC8yYoWNwjFvNgmeGriJo+qNhdvNmYYMUydJDo9AiHWn/XJr3ofXxymxTyQumWJB2UCJJy8UPTPFntm+fum4k6ZxL3SHSL1SQH7BPElXXQ1P7yGAGsyQx9M1fPX7DX9Sn15Gx2OZfIKZfhNro708lxR+AbwbcFTXWpaxeOorZew0FZtqli2IypgMPxDnUQ4nlelco8YkVO06IauLkS8T3847L/UpJUa7hzSKEy3SxL5na0EI1PaSLLFlZfuESXCm25p+GnT6YAE0P6SL79FrXUWathYnP5QcZZV0HA6hrpG+95vts9/DA5SfBn4McU05gtgsjjYE5D3EQE3hX4jH8gRiESI6ernSMOM7ADHUK4nQFIoQ8s/4wJoJhkSsIPIgT8MDPkMuIyo/i0niRe/jTbdU/DjoEmQclkvTcnEveNqtZAW6Vu4zQ/Fu+FlV5+aJ42YiqPK/KB7HeAbu4fnN0TKv8cSXWn96e6vJdlPVOdX4B8cyZ0mPBh5IiEt1ibxt6dcH1Q1488bxt811zxXKm2KL8H55B+9Rx3vARgwdLDDGFp+1ZkaaE4N7wER9amTf32h8kLMsEz05TSl+sdESZL8r3xU63evelYi/BaCYWeLIo1+dV2SjJRKnC5TCxIJFdc+5e8NyUe1xZ/7Lh5Q2ixKd2+Cji+anId1Us2bTAk3X5xbJtGxo9vtST3fOiuodWNkcpmpU9GlN3s6BWR6DYk+cekGsSPY6lO9tlOHuUIUbyqnx/xcu12pyzItsVkO6AywZL35V5v8gI+KROLHDkYZ8U7CNtqmnEJg7ZUJkrEZ6jGHRICnwyhDzvcb7h2WOz2wZBvY5GOWyOgOIOBjRuVJ/NaUTmN0ruMkBl4DBBsruJMdhApSFOwOv+E0Xt/pOAfVk+RYEvyycKtd8PFvw4m2oKse0qDyuX4aP5XmNKPEtZqSqrgkscTDV5cYWxB+FUroEFMDJAXnSV8yzI0iL6JVbrUqgKOu5lybGXN2y4uGPBQRxDjOVtt+2wWNk5ArZ1Z8zQMdRVyUsFbUxYeiy1/8DcF3zFZc6hlfWMHTqK2JJPVOalYpmCFvhITOAd991cVQyaF2jekhhJLJ9M1euEwOV9EBN4oIeZ8uxWjwI6/WGIsbx6Dx6xNcRYnmzAV3eQIlmSM8X1Zg7onbMNcNwLnlV5eByvl2EZbasLN4fjNcbG03ApWCH+4P0i2pudqnfBIp+zw0ahmCh4vuRcRvQ5Z8yQMYhwZaQ1WO/9VsUwohdiOU0mxVanTqqA8xQOEzS7rhrINPtRiSRNNm7OcJx7N2MplyX4WILLMupIgvE+UVDd08sIDFGuYY+FqcYSu95dmNXpyN2UwdEZZxJSmmM17RIj5psdJjQ2vOedqrs9+AmvBT4qkSQpy+ryJeM15AtpqtHESgJ3n4y1BNpd9cgh19YrkaQnQI3Zir60f+zWAPfedw/Iuf0dQ0OcTUI/gWRRClh5aiGBM2y3AbEGcQIe8Ds0NUnBjrihSbYjpaKT3p1u6+k1k82GFZDqzWWUkN/2It6Haz6PbcJoVuhYVkkiaUfQYtoR86ZpYlnK6klAWqUzdoQoIo4zIp9eFM1Cv4MvbFsXHFjvjcUkHnAo2VRjid3fhv5QOzIBxc+a4mJ5z1W20RuThwEKWKU7Y4aMQYAzZY+kWFY5Ho8J8wx5EuapXLf3DnCxbrskUcBGsJxGSH7BX8R9wYcZ8yaiEvfZYqOpmHr1rt0qEqYftXRaxOKCGTN0DM+uJG6z6Oe5XG4xRNi6saMSRwLv1iFu1PmBq9OiANZVhhjPe27ON7vykefDWJOdPWWePmOaPJaIAvF7QEcGnuUZawk06PXSr6u1v2OjpdhwrGGGi+FH1mxCQK0hD0pqJxFVoyWn49t90bBG2FiLLFXYVm7SZu3eOOaSSK3aH6um3/0e8WF3GiH5fXYd3Kyh35oW0Q1oVNZU04iwzX6mOgUx5s7PGaaIAz7WnzYnk+UNODLgtsJH0DfW8S+C1wE5LuDXM1XvUvuZZHmcRzqTPMawJqkS51nOjIlxLDtrog/mSp4YQ9PprmBPc6fEkaCrJ2nLJgdr6Dtq69NQYVWl2woZQZ9Nt327YK0QhwmW/VDBmiNHJZ4kt211BZpws/VYqlACNdIzb5koEthoz4wZNgb17m2YqN69Rfo/fKwvX5RkkE6Dw2TCHhPqrEt22i+hvakBd9Jhg7y+pt3sBfxammokEZj/g5b6A5p1g5ZwY7C+5Wony1ve7Irw4++wodF/FbzI4+AjExz7J76HVbIHIY5zJTJeNsB5GkOM5ZXA7YpHJZ507AnAmbYNnh4BJbIaZeetnkMNSvJQy1W1XocbXJ0KeVmtLbDmNMRYXvW4qyfJs+d4IzGFB76+kRjHu2Y17Ck5CMkPyTXPBbvb18D6xZIjLxPWSyT1EId8IrC1l6YaSaye4GlrDDGS16fhSZe6Jt4jLfJ0EX+pSPUujvgRFbcVNgK5bXsKOaxmsPU46k17uFdRPcNqBUtOZAI/yrYeSYWxKIRSHwkC6dMclUiSPpdluQBe0liM5smINTWWnMiEvQ6WnPy5HKpG+OTk1AJ74amq+S9dvUeFgWX0RwVFDK85THDsyMxrSbKu2Se6zqIa+xzlL0HALjmMYiC3aEQx3mAZarNQfAt9AMZqPBH4XRxJkay4fY9J9jsuZZXxpgHkKDkq0aStaDgkv/FIimbVXKr9BdebGmvAYNzUAk0GTbfQplm67N2ge9bqkJTVT0OWqg98XSlQB8tphOS/PADfvEGI4/y847tuoRZTfB2cl7PkSZgr8UfwrXCY4NjDSXlne8W71WnHM1lDQfhs00czPEmUqAYftOhgaxJN9Z9PxLYPTC9RucM9piliOfv15uy2bTTGBXK0SxFFn3Ih/jWZMU8YE6ZwDNMUsbSbUmNfVodpiljaFdAiw5SLYZomlr6QgV0zv3WKiPT/LqqSw+bsfLapoml7wdhwRsa0eH6RQul/zVNs/WGMbfD0m7LYQ7KOjLV4mo454tMykmOZD1zq9LWwlpwlxzL1CQcRSzUnBnhuA98mbsmxzG3M9IclxzLrgmUxUFOPpbZrCXVyYuizZBmQuMD9dKY6BXEYIIwjD1akCMAP8lj95xPxrd7WC2zVpyEm80S5Bq+dmzHDxtBUxU51a57bvwXplgGB6x7zvmNr8G0HOEHH1y4ehr9tpp5GhVZoYzWNCBzTtORYppJ73VC6kyycy8RUE4htzwJyFK+pJhCjmhymnkCFjlsZ4gS8qF0X85YJIgnnn7LkBCYoSdNRiSTtSiW2/LA/Jciz9Djq6s0hDzngCTbVWOLlS90egw3cEzExSMSFDtvPGuLjwOxhmrPDRoHdXDZvmSgS8G1JucVs9SaiIjfESJ7OuKJzLMJaQZYcyWyTEQAyqh+EWI5e/gFrbIy1WFpVQ5s2Yy2Slj/2KaDEiwi/s4Y6BbFr+YaH6N1WyAh4tpPQjMyGOAEP+oI4bAh0ofa6CyYk34Lzlc8a0uLoare4EMY2WLrM+XD8LqD0x2o0EbfPbNYQHccTdLnRWEuhDUeFx1BNGyR9w2o+SugdrlZsA/Iiv9bjKi6AVUK8WJdM7ST/9PZc7mtVQVJvOo2Qd+DoKpJMY8YMRqUZhVpthdrEdSAdJhQ2OJewJac/ZO3myX53jL5v0I/ajB2yEIYtnEN+GcgyaacRlq/P/Ab1pUdSJKvm4JPfx1o6DbqGwmVDpMdQ8TS9uisbpzse/EEf6pCDVHGh4yHG0S1FarPMAW6IKacwdfYowAd0pKXQlqKG5recGKC5u0x/+2C7ESw5vRLfZXotLHBO0FTjLviOrfXR3SFUL0MzYI3OgxDJyerotAMuGyS9nTgETl0bYiSv+scK2F8eSZEsPWXSwN6JsZb8Qnwscy6LvSjX7RLM9pMdCsBlg7vso6eVKIPrz0x1CuLpfSUVdPmbxzRFLOdF1XBcLIZpilhWimHLxTBNEUu7kgkXi2FKjiXy3Uj0XrRezlmZ8QJRCA7rNBEtdwU6nrFtmmiwz+vUGBnP7VWQenuF9C2Ldu9VsLVyEKKvYcWZzDbtXFAD7YzMmCFjaLg8XfOo45hcNjj6sCwUtsrSVP/5ROziKdNL9AL5gHnCmNraGxdPZ4qL5b+3BawxfRDiOJ/bFkQ7FlgcUWpfm5SxzAJ9893fXn37Ggazks1NMa7sctGA2QNyZnj+o3mi8fZJIDNU54kjMbDJ/ukpyL1fOgLy79d8e8+l3SWYksY6Ai4MSoS45Q9hyi1/wINO75s2h94H/mwOHU5olpKALPe3RmrVKapTEBDLxQ9M8We2bx/ivqbTSycqqWdRJl3VaQgwD8lC7Ne/Rgdm2qUIp9tOG6gCXfK08PFyNxB+suAtJgC59tVQ+meKc8n2Z7uHBy7NfeEOjqFMgvwk+DMMqZUE5E5VWaVPVVLeSxzJ0sCW+kBffYqwHhPUycOA9IkdIZzn5lzydrEcK+ZX203D8dnhwzkT6wueiS0rgh8qW0qCLkrF14DPsC2lQEsm9137oV0v76VaWio28DIfRSRQ7kfY+VginetZbn0EtzVO7CQZWjL2grMI8FhNRreL4sLMVkaAFdV9+FU4iFKAfN+wkYqAqqqCsxL4wk3EZHC4PMc6Aq79IA6HG/l4hpACFIUSpZm72Mt16P+f8ZNBlpgA9ooDnypTiUcOp9AZq22u+Jplew/eYxUIBTbHdDytTSd18gViCAnFUG3rquHvy3ZM0gscCwlAyZniOotleORjosVjL5jqzqfx4A4aAqbrKLY9kmtW+2Cmkoxsrqvc9+KMZQRYf2Rp+N5ZSjoyWPmbQgJwX7KtyNr6Rdd0/ka8Q41HX5Z5XYlhHfWQr8tDdxvQA3Btj5mFz+6IiQG7s6tMmZ5UKtE4/xtz0BAx7ZoYUa6vRZ4X/JnJIHRqQQghXBXR66DLl6zY+QuzU+AR79uTPnzvQq8gIPQ5ucV+WNfvQ5lKPLJfLwVAWkoCsm09nTFfu/agoWI+sC33VSEjFRV1y7NK+rrLYxkV1piL12dYjWPNejQq1CJO0hoeZRT3oY6qJCg9Hx1qlLnkNPgVu+fFmVDXrPF9aWwpDbpk+6JiOQxrimngn3dc7rsFBzD41IAWwFzWEyfcm2YlGtzlddCfcNilOyzShAC9eEONRy9OP5wOmZd4fi22oYFxtwEhgJxv60rxMusyBISLf8YiQQgqAq7o2G5kG1Z1T8UE8PITl42/DXHQEDDdEWU+SKcgIPSmjS7hsz7Kb5ofYop0WxBCOIxsmSn7pmRDiAf+xH0t2584oVX7E9/75lL1zwTnZfU8HuL1VXETLR57JUq+rHywXkFBdOttvIxOQoC0x1YBWv+mMBXwNM9Fd1yDmUIogDfNSMFc8SdeLHzVyVFEAZVrWI1sKSlIfWAX6M6OhRTgM5eZsX3Gweo1eMw1qwMTn72ChLirjDRoMyeQuNA+S0JIsAVmEevLoAeotaeUhRfRmULKhY78hF6WqZgC7nLM6aEAL/Ioo8PuvIMgIxUBdXn3483FyofpFAQEZFwxxVBieJEgeXHgB/6iAJXmWEaA+cd/P5CGfrV1oNc1SCiQcrVhkufdRLSXZSiT1E4fdludSjxYLRo6/MXebL1DbvpngvMStBBmLKPAgMtfTCEBqM9jq8X79nx0H2+sc+JMp/YGU5dD577SmNgnR2v5eBMxHnyY1rqqstB1TrQJsPYuunmoc//c5H4d5WrvrcVNIelKGp4HatmjiAgKNw/HMhJMr9f0c7SCjABd0UhIAArvpKv+meC8n5X2j3GMVCRUaNEtcH0t7At4HCvXr4t/Tm2ixV/mLSvXvneq/Z3g3jiCwrXfbUqcMUkVhH3SSSAA5+kmJHhwJHDOhBZEVRa+l2aQUCD3/kXGnYAKWO3LLAjRIgooMP9Lnfntj3jwP4WdhALpNvQM6wxZke2KUOtj3ogcyHDM9E75p2ldchpcSO6/m52EAukGiryQTkKHRI1jfYkhrJijff0BQU7zjQusm3Ttn95PrBB5+ImfM6IEMqTID/TbTSEJuJNlGNaLKKAn8RSouFoFHmFmSg9c01RMAIdGHxIOx46TN4cu0ZJSLzD8jho6Ks6/8xi68TimVLtUTUFoJ6NeXufFzl3gRTrzF8SA88e2yvDhekmaUm0TRIfXBBg6wuUZmZhDL8dETAGXTbePM7jMw5ZSoENCXsBg9VRMAj+JjHebRR+Et06faAlYnYU4MDVz0CTANDXzjnyZQgqwkgo22WVLCVChdyCHv1sjGQE2n4RwSgwkH4zG6u7pXucb9RasJaVA9TDohXGylQM3iAigLoWqrqvDt9HWUrF61QmQepRSodesBjIPSiryMHUABFt6Kh5ITQlb5MEWwlSdCq2fFTBZi1OB/XtTJtpUWMjs1YxFqhC6Gh7M7+TJ4G26YDi8lZPhwE/fREwGz+VSnmN7kylH4fVwsM7/CskH4FCT0AK67m2ipWLFwz6czMiWUqGQ8j3ICLB9mQEGD8cyPOyOrb3rI9vfSe59TUL9M8G52PJGsW2td1br/wRv0IxFihC6/c8REYwNEgRwWVfZZsWzqswn2avno5haJQgF0GmdaBNgYVWRS54CrlT7UMGL3rRIEEI4S4stJUCrf6zCY4YjFQVlnHDigEyPNYly39XakKsxlASkHvE7E+qTdaTFlGgICUD/eBlthExb522itwCiE+FBH8vAXHInoAICc8lHEQUkwl+Ko4gAul34CLcLgush2bMPMGgSYJZM+F4VQ0fA7UQO+45YSjzSmXz4qT+NzkDO5h9+AyNZaTedDEeuzRjvdt7feYYr9S+Q9L6omHr1zqpznKixFMWa7I1wYpwbI4AEe5rICXBNDwH9DyuH2hNCZpdcOak+U1IsdpZ1L92V1h3FO/v15sxe6QUgH80SxODJ8g4IJZDknRIRomAMS2Qk4eVIM4HAliSB4wgvEpmJA7ZQBBiHYuvmbG/OhDm5RyGKY5yS4QRMDskAep47R8EJ8R3cgOLFvl1RRyhQIrJPUIBH4zpAARhJ214wt1Rtq3xnUbXnv7CRtGO8ffXd2zffvIWB9Od10oGaZWl1dVDH44ZaCEyUvUE89LcRdtgqfOTxcrdtvh7+bt6jv4/Lpxan9WgaosXx5uvu76bdq9eWpTVpM7J1TNBMrK/Y9j5nc/TDrwEvfXXr9NH/FvTQVZQzLrof/T5q+xSao4faddiMaX/GGpHpDPtT+8NPIPv3ojBe5YmXTuDz5aqfBjdztY/pob31Or+H1Ifqup4PW+HzdlWtJ/nPBj/H33wejvs/uzwvLk9Tjc9jv1ds7p4bP/v8LKUoM1GPO1eDj8NPPvv+8Z5kahycmL/7PHXnjE89dH8PW3ZZEuYKZKrxeVy4nuS21uwO11nMPcivv31nu+mOrJh30/3udXMh2kFgNn5sxm6Ov3vddFfvdtH95jP/R1OVS6ayUQ3R9foPPzg7+dZ75NwDefgh5IHV4mj70I+NN1+zWpiW796aRq4axTCfq1ZsR4t1WY13ehtOuh8hDoLx2DK/U8dsuuFtZu7cdjP5jBlOnB+yqQv7O2b5cH3JbCfDAsUZJ8PPHif3Ve601n/3mGVV2eyMlIlH0+E3v3l/u879jiwVyOX8J83l2v95m0F8qMwGgMtxpwG5W8oq32WhQhhUIJe3VcGb06Konsdzvy63Y6XH9cXl1eXdpctV94vHlANuiK3xuPvh8s7l4YfLO4/RxhqVONptHKMOhmk5e7PL0C1ent6d/+iybH/wGGoDK9P50fjwo498s3KWkv67jztt5Iy47maO5WD+Ua7DD/Dyozvqj76gfz/sWHXZHn/1uJDs+WymJux/8hnPfw1k8FMgPd8BGf4IyMB7LmFvtxJbt337w8Twt/8DaDrVPg==" \ No newline at end of file +window.navigationData = "eJzFnW1v5DaSx7/KwXsvs5fMQ2Y3weEAP03iTXvccXsmFyyCAS3R3TyrKYVS2+4c9rsfqIdukaLIYhUn92ow7n/Vr0RJFB+L//zfk4a/NCffn/ynkA1XkhX/dfLVScWazcn3J9sy3xW8/vrz8Nvn/9g02+Lkq5NHIfOT719/dZJtRJErLk++/+fB1WkhWO310ipMX2+/OskKVtcn3580df5XUf+Vv3TyEzdlyVTNcyDmL9Wg7mmvvnv75hsP81+//eurA+qizHZbLhsvbBAlvqwW8MCyGVgnt27Lt++AF3b5xGVzuRVNw5X34sZC4gWOXZ3We5nd8rrcqYwfA2gdegKYdWGG9ur13z3lcCyF0/tSNey+4KFSN4I4WMUUvrvojWu4qRpRyjoqlpAzeoi3/IErLjMh1zM3LTLMOYe4UD+UOW+93zG15k1UVJYtvazi3qS/cP0XfjDFVFCrjBXMz+0kxHf3bHFz/tPn9zeLi8uLI63ZV07WWG2V6jff/e3Vt69BJdt5WVzdXd6eLqDQXo6nLhenVx/CtFaGp/z88ebu8vPFzcezxWUYNlZTmaurDz/AmZ2aeg/t5+aJKaEr0Lhn5w3psQkznY8OEGo9NT6Y48kBQtwPjY81/+BEIe1nJox0PTfQogw370ZVWnz77ki621cczGk6MaqSbhRnWz+plRAraVnm/Pu69fR1pcqtqLm/Nd5Ttd3nzu7zYDdt70eF8l5IUW94DmzT+AKxXOG+0g+9k2MgDzuZtQ6hcQwuzADewR61SlS8EJIT+IOLCP5v3hKYfyDclxr9PH7ugxcP+8+fYVd+IBu2yEueFvr8JbtL98+45AM5xSVf7KqCv3g7VD22U+L6TUtW13cbVe7WGwhqJMfx7hST9UOpthDaQYxj/aKE1SWcRw1aZO9TKbaPqyDHJriKsLvtcVTDBofFfQ+SVP1LUQU7q8ODKipkN3TZv8Rx12dZ4dC3nOX6IYxDW1Y4dOcrDmzY4LCHNzyObJvh4MM7H8e2rGgP2TkrinuWPfo6ceYDNlgQusW9pwteN0IyfRVw/MgoaQRXDVe6VN/3n1dURLaTpBEuu9YbKUDLBz2+3iE8mN6ATl5ZQ4ch8Mo1Mojmxt8F044eh6MhEwphpjlDosfeBssQH8nBEbwKm5jg6SzP27H7lVh3LXhA69y0QfX98rb5tGRCwZBHPQoX19Ul9WrXvLngD2xXND+K9eYX1nB1zdQjjDxjjApE1JdKlQp60Qc5EjY0nqC0QY/ETbskfpy7W/JFRioQgxJHVE15fGaMkf3mX0+vF9es8o4U9JovP3s9BtHmr7WnFf89SFvx3/+cyxpAtMs6LdalEs1mezUicrnbWosADirz4oDd87Ux8e8YBWgVyL4/zPlfXyHdmwsxXO6nCzHAzpdXftfLK6TjSpyV+d7vvNNMAFM3V/KhhLjSuoC7m4orq8vj9ncQQh1CgjTEAcdLpph/lGwQeR2BV2ekWISxazbvRdFwFS4MQ+q7grOivPe60gJcvGdFmT0uRO1/fQ8qHOS8EFw2t/z3HQ+ADCUSVhYFz4LP91GGxciGCTleJuGk9Coi5Lr9AMFQnRYPVLpkwo+vKfU9vhdC6ZJ+4v5K/CjDxT5d3uaCOJe3QRGXMq9KIZtg4YyFvqJxr7cJLRxDxf4jZzlX/lvQa5CApqkg7/hIRwHVVSlr/ysxFuJQVzIrt0Kur3lds7WfZmlxwAX7Y7/i6klk/CrnshEPIvBkOC2QcD24Wu5k6GEc6XAgvVbtjAXu3iDCIW4qLnWbaCeKPHA5ppSE+4FL3bwpQcCD2FdD3OyadQl8Ai0tdjpU+KOfjuVAXU9HGhzu3cMLcES4AiJVPqCKh1bp2MsgXVO2jmWQcPcbvmUB91qCdF9mj9x/AzoJxf1pnite+z9mhhIJs9Y6zU+eo9x/vF14fX+8XaAdrzhT2abtHPmLydLigHo0pB2F9KIOKjzEGNaaQUyGtWIAxgDTDGAywBQD+IUpKeQ6COl1ONDn1Rvd+NFdzPZd5u3N5Y3RAHTP8XpMcRO97YzDj0zmxfg77IaPtQSaPSfigbmmQr4syx4GM2g5rxTPWMPzf0sPfo28zDxvux96AEA3WYCLBWbM0DE4xq1mwTNDVxE0/dEwu3mzsEGKZOmhUWiRjrR/Ls370Pp4i7P2IQiyeh2NMunj+mHO7m4s83pXNOITK3Y8kj4xTBXHzzuu9qtGCbmGV/tAN7QYSZF9gXj6noAeytI/AAMxrZARyGxTqgvWsCD1oESSllc/sIY/s30bfDfCes6VHijQH5ogP2CfJKpu5KLZRwYzmCWJwbytn15HxmKbf4GYfhHNRrfLSiX+ALSl4K6osS5V+dJRzFGdUGCmXboooDXxvGm6WOK/DxAnXyI+XO0c7zJd7EvWbGihmh7SRZasLL9wCa4atuafhh1wmABND+ki+/Ra11GRX2igH2SUVRUMoKqQvvVeiLPdwwNXnwR/DnJMOYHZLhg2Bqw9xEFM4C3EY/gDMQiRHD2N7xiJn4EZ6hTE6cpcCHlmXW5MBMPibxB4ECfggZ8hlxGVH8Wl8SJzW6RLYXEcjAsyD0ok6bk+V7xtVrMC3Cp3GaH5t3wtSnn50nBZi1Kel/JBrHfAoR+/OTqmVf64EutPb091+V7Jatd0fgHxzJnSY8GHkiIS3WJvG3pVwfVDXjzxvG3zXfOG5axhV/J/eAYda4rzho8YPIhoiCk8bc+KNCUE94aP+NDKvLnX/iBhWSZ4dppS+mKlI2R+Jd8XO93q3cuGvQSjmVjgyUKuz0tZN4oJ2YTLYWJBIrvWonjBc0tR4sr6lw2XN4gSn9rho4jnpyLflbFk0wJP1uUXy7ZtaPT4Uk92z4vyHlrZHKVoVvZoTGnPglodgWIvKvGAXItL4li6sy3DWdUMMZJX5vsFl+tmc86KbFdAugMuGyx9J/N+8R3wSZ1Y4MjD/kHYR9pU04h1HLKmMlciPEcx6JAU+GQIed7jfMOzx3q3DYJ6HY1y2DQExR0MaNyoPpvTiMyvG7XLAJWBwwTJ7ibGYAOVhjgBr/tPFLX7TwL2pXyKAl/KJwq13ycZ/Dibagqx7SoPK/rho/leY0o8S1U2ZVYGl/6YavKiI2NvzqlaAwtgZIC86DLnWZClRfRLLNdSNCV03MuSYy9v2Ih0x4KDOIYYy9tu22Ex2TkCtnVnzNAxVKXksoE2Jiw9ltp/YO4LvuIq59DKesYOHUVsyScqc9mwrIEW+EhM4B33oy1KBs2XNW9JjCSWT6bq9XPg8j6ICTzQw0x5dstHAZ3+MMRYXrUHj9gaYixP1eCrO0iRLMVZw/UmJ+idsw1w3AuelXl4HK+XYRltqws3h+M1xsZTcyVYIf7g/eLym11T7YJFPmeHjaJhouD5knMV0eecMUPGIMKVkdZgvfdbeMOIXojl1JkSW51SrATOUzhM0OyqrCHT7EclkjTZ0DzDce5pjqVcSvBxHZcy6qiOI+tSguqeXkZgCLmGPRamGkvsendhVqcjd1MGR2ecKUhpjtW0S4yYb3aY0Njwnneq7vbgJ7wW+KhEkpSS5eVLxivIF9JUo4mlAu7KGmsJtLvykUOurVciSZDdJoStJnD/2C0z7pwQHpAzLQSGhjizh34yz5UUsPLUQgJn2IYGYg3iBDzgd2hqkoIdcUOTbNNLRSe9O92W7Gum6g0rINWbyyghv+1FvA/XfB7bhNGs0LGskkTSjqDFtCPmTdPEslTlk4C0SmfsCFFEHPNFPtUrmoV+B1/Ytio4sN4bi0k84FCyqcYSu78N/aF2ZAKKnzXFxfKeN9lGb9gfBihgle6MGTIGAc4gP5JiWXI8HhPmGfIkzFO1bu8d4GLddkmigI1gOY2Q/IK/iPuCDzPmdUQl7rPFRlOy5tW7dqtImH7U0mkRiwtmzNAxPLuSG86in+dyHMYQYevGjkocCbxbh7hR5wfenBYFsK4yxHjec32+2clHng9jTXZWoXn6jGnyWCIKxO8BHRl4lmesJdCg10u/rtb+jo2WYsOxhhkuhh9ZvQkBtYY8KKmdRFSNlpyOb/dFwxphYy2yVGFbuUmbtXvjmEsitWp/LOt+93vEh91phOT3Wadws4Z+a1pEN6BRWVNNI8I2+5nqFMSYOz9nmCIO+Fh/2lxlljfgyIDbCh9B31jHvwheB+S4gF/PVL1L7WeS/XQe6Ux+GsOapBCdZzkzicax7GyiPpgrqWgMTaeBgz3NnRJHgq6epC2bHKyh76itT0OFVZVuK2QEfZbp9u2CtUIcJlj2QwlrjhyVeJLattUVaMLN1mOpohGokZ55y0SRwEZ7ZsywMTTv3oaJzbu3SP+Hj/XlS6MYpNPgMJmwx4Qq65IA90tobyrAnXTYIK+vbjd7Ab+WphpJBOb/oKX+gGbdoCXcGKxvebNT8pbXuyL8+DtsaPRfBS/yOPjIBMf+ie9hlexBiOMsRMZlDZynMcRYngRuVzwq8aRjTwDOtG3w9AgokVU3dj73OdSgJA+1LMr1Otzg6lTIy2ptgTWnIcbyysddNUkqP8cbiSk88PWNxDjeNatgT8lBSH5Irnku2N2+AtYvlhx5mbBeIqmHOOQTga29NNVIYvkET1tjiJG8Pg1PutQ18R5pkaeL+EtFqndxxI+ouK2wEaht21PIYTWDrcdRb9pD74ryGVYrWHIiE/hRtvVIKoxFIUh9VA6kT3NUIkn6vKLlFfCSxmI0T0WsqbHkRCbsdbDk5M/lUDXCJyenFtgLT1XNf+nqPSoMLKM/QitieM1hgmNHZl5LknXNPul4FlXb54t/CQJ2yWEUA7lFI4rxBstoNlcN30IfgLEaTwR+F0dSJCtu32OS/Y5LVWa8rgE5So5KNGkrag7JbzySolkVV83+gutNjRVgMG5qgSaDplto0yxd9m7QPWt1SMrqpyFL1Qe+LhtQB8tphOS/PADfvEGI4/y847tuoRZr+Do4L2fJkzBX4o/gW+EwwbGHEyTP9g3vVqcdzyoOBeGzTR/N8CRRohp80KKDrUk01X8+Eds+ML1E5Q73mKaI5ezXm7PbttEYF8jRLkUUfcqF+NdkxjxhTJjCMUxTxNJuSo19WR2mKWJpV0CLDFMuhmmaWPpCBnbN/NYpItL/uyglh83Z+WxTRdP2grHhjIxp8fyiRKP/NU939ocxtsHTb2Sxh2QdGWvxNB1zxKdlJMcyH7jS6WthLTlLjmXqEw4ilmpODPDcGr5N3JJjmduY6Q9LjmVWBctioKYeS23XEurkxNBnyTIgcYH76Ux1CuIwQBhHHqxIEYAf5LH6zyfiW72tF9iqT0NM5gm5Bq+dmzHDxlCXxa7p1jy3fwvSLQMC1z3mfcfW4NsOcIKOr108DH/bTD2NCq3QxmoaETimacmxzEbtdUPpTrFwLhNTTSC2PQvIEdWmmkCManKYegIVOm5liBPwonZdzFsmiCScf8qSE5igJE1HJZK0k43Y8sP+lCDP0uOoqzeHPOSAJ9hUY4mXL1V7PDxwT8TEIBEXOmw/a4iPA7OHac4OGwV2c9m8ZaJIwLcl5Raz1ZuIitwQI3k644rOsQhrBVlyJLNNRgDIqH4QYjl6+QessTHWYmllBW3ajLVIWv7Yp4ASLyL8zhrqFMSu5RseondbISPg2U5BMzIb4gQ86AvisCHQRbPXXTCh+Bacr3zWkBZHV7vFhTC2wdJVzofjdwGlP1ajibh9ZrOG6DieoMuNxloKbTgqPIZq2iDpG1bxUULvcLViG5AX+bUeV3EBrBLixVqyZqf4p7fnal81JST1ptMIeQeOriLJNGbMYFSaUajVVjSbuA6kw4TCBucStuT0h6zdPNnvjtH3DfpRm7FDFsKwhXPILwNZJu00wvL1md+gvvRIimRVHHzy+1hLp0HXULhsiPQYKp6mV3dl43THgz/oQx1ykCoudDzEOLqlSG2WOcANMeUUps4eBfiAjrQU2lJU0PyWEwM0d5fpbx9sN4Ilp1fiu0yvhQXOCZpq3AXfsbU+ujuE6mVoBqzReRAiOVkVnXbAZYOktxOHwKlrQ4zklf9YAfvLIymSpadMatg7MdaSX4iPMueq2Au5bpdgtp/sUAAuG9xlHz2thAyuPzPVKYin96VqoMvfPKYpYjkvyprjYjFMU8Syahi2XAzTFLG0K5lwsRim5Fgi341E70Xr5ZzJjBeIQnBYp4louSvQ8Yxt00SDfV6nxsh4bhdB6u0C6VsV7d6rYGvlIERfw4ozlW3auaAa2hmZMUPGUHN1uuZRxzG5bHD0YVkobJWlqf7zidjFU6aX6AXyAfOEMbW1Ny6ezhQXy39vC1hj+iDEcT63LYh2LLA4opp9ZVLGMgv0zXd/e/XtaxjMSjY3xbiyy0UDZg/ImeH5j+aJxtsngcxQnSeOxMAm+6enIPd+6QjIv1/z7T1XdpdgShrrCLgwKBHilj+EKbf8AQ86va/bHHof+LM5dDihWUoCUu5vjdSqU1SnICCWVz+whj+zffsQ9zWdXjpRKj2LMumqTkOAeUgWYr/+NTow0y5FON122kAV6JKnhY+Xu4HwkwVvMQGota+G0j9TnCu2P9s9PHBl7gt3cAxlEuQnwZ9hSK0kIHdNmZX6VKXGe4kjWRrYUh/oq08R1mOCOnkYkD6xI4TzXJ8r3i6WY8X8artpOD47fDhnYn3BM7FlRfBDZUtJ0CvZ8DXgM2xLKVDJ1L5rP7Tr5b1US0vFBl7mo4gEyv0IOx9LpHM9y62P4LbGiZ0kQ0vGXnAWAR6ryeh2UVyY2coIsKK8D78KB1EKkO8bNlIRUGVZcCaBL9xETAaHy3OsI+DaD+JwuJGPZwgpQFE0Qpq5i71ch/7/GT8ZZIkJYN9w4FNlKvHI6RDohDUz0BkD6Y+6M5b0LPiaZXsfd94qEApsIut4JJzOHOULxBASiqHcVmXN38t24NMLHAsJQMVZw3WqzPDwykSLx16wpjsEx4M7aAiYrjfadnuuWeWDmUoysr4uc9/bOZYRYP25qOF7ZynpyOAXxhQSgHvJtiJrKzFdnfp7Cg41Hn0p86oUw2LtISmYh+42oAfg2oMzC5/ddhMDdqdwmTI9+Vqicf435qAhYtqFN0Kur0WeF/yZqSB0akEIIVwV0eugy5es2PkLs1PgEe/b40R870KvICD0YbzFftg84EOZSjxysoRrgnIv24pHAK7KUhKQbSvwjPna5wcNFfOBbbmvlhqpqKhbnpXK1+0fy6iw2lyEP8OqHWvvo1Ghln2SVv0oM7oPdVQlQel59VC7zyWnwRfsnhdnorlmte9jZktp0CXbFyXLYVhTTAP/vONq3y2cgMGnBrQA5rK3OOHedDHR4C4/hW4lwC7dYZEmBOjFG2o8+ur0w+mQQYrn12IbGuB3GxACyPm2Khsusy7TQbj4ZywShNBEwBs6thuhh1XdUzEBvPzEVe1vQxw0BEx31JoP0ikICL35pEtcrY8knOa5mCLdFoQQDiN0ZurBKdkQ4oE/cV/j+SdOaDj/xPe+OWH9M8G5LJ/HQ9W+Km6ixWMXQvJl6YP1CgqiWzfkZXQSAqQ9fgvQ+jeFqYCneS66YyfMVEgBvGlGCmbBn3hx5atOjiIKSK5hNbKlpCD1wWOgOzsWUoDPXGXGNiAHq9fgMdesCkzg9goS4q400rnNnKTiQvssCSHBFspFrJODHgTXnrYWXgxoCikXOvITelmmYgq4y5WnhwK8yKOMDrvzDoKMVATU5d2PNxcrH6ZTEBCQocsUo5XhxY7kRY4f+EsDqDTHMgLMP8T8gTS6rK0Dva5BQoHI1YYpnncT6l6WoUxSO33YbXVK9GC1aOjwF3uz9Q656Z8JziVoQc9YRoEBl/GYQgJQnytXifftOe8+3ljnxJlO7Y2yLofO/bExsU+OCPPxJmI8+DBztiiz0HVOtAmw9m7AeahzH+Dkfh3lzd5bi5tC0pXUPA/UskcRERRuHo5lJJhed+rnaAUZAbqikZAAFN55Xf0zwXk/8e0f4xipSKjQ4mHgOmHYF/A4Vq5fF/+c2kSLv8xbJte+d6r9neDeOErDtW9vSpwxSRWEfWJLIADnKS0keHAkcM6EFkQpC99LM0gokHv/YulOQAWs9jILQrSIAgrM/1JnfvujKvxPYSehQLqNScNSRlZkuyLU+pg3IgcyHJe9a/zTtC45DS4U99/NTkKBdANFXkgnoUOixrG+xBBWzBHF/oAgpxLHBdZNuvZP7ydWiDz8xM8ZUQIZUv0H+u2mkATcKRmG9SIK6Ek8BSquVoFHmBnfA9c0FRPAodGHhMOx4yTUoUu0pNQLDL+jho6K8++ghm6gjinVLuVUENrJqJfXebFzMHiRzjwMMeD8sa0yfLhekqZU20TX4TUBho5weUZG6dDLMRFTwLLu9qMGl3nYUgp0SCwMGKyeikngJ5HxbtPrg/DW6RMtAauzKQemZg6aBJi6Yt6RL1NIAZaqgU122VICVOid1OHv1khGgM0nU5wSA0kUo7G6e7rXeVO9BWtJKVA9DHphnNDlwA0iAqhLBavr6vBttLVUrF51AqQepVToNauAzIOSijxMHQDBlp6KB1JTwq7yYAthqk6F1s8KmKzFqcD+7S8TbSosZPZqxiJVCF0ND+Z38mTwNu0xHN7KyXDgp28iJoPnckLPsb1JoaPwejhY57GF5DVwqEloAV33NtFSseJhH07KZEupUEj5HmQE2F5mgMHDsQwPu2Nr7/rI9neSe1+TUP9McC62vG7YttKbt/V/gjdoxiJFCN0W64gIxgYJArisymyz4lkp80kW7vkoplYJQgF0WifaBFhYVeSSp4A3TftQwYvetEgQQjjbjC0lQMt/rMJjhiMVBWWc1OKATI9niXLf1dqQqzGUBKQe8TsTzSfraI4p0RASgP7xMtoImbbO24R1AUQnwoM+ysBcciegAgJzyUcRBSTCX4qjiAC6vfIRbq8Iroek1T7AoEmAWTLhe1UMHQG3EznsO2Ip8UhnEuWn/lQ9AzmbR/kNjGSlD3UyHDlDY7zb+YvnGa4UxkDS+6Jkzat3Vp3jRI2lKNZkb4QT49wYASTY00ROgGt6COh/WDnUnnQyu+TKSfWZkmKxs8V76a709Cje2a83Z/ZKLwD5aJYgBk+2ekAogWT1lIgQBWNYIiMJL0eaCQS2JAkcR3iRyEwcsIUiwDgatq7P9uZMmJN7FKI4xmkfTsDksA+g57nzIJwQ3wEUKF7s2xV1FAQlIvskCHg0roMggJG07QVzS9W2zHcWVXv+CxtJO8bbV9+9ffPNWxhIf14nHahZllaXB3U8bqiFwETVG8RDfxthh63CRx6Xu2399fB38x79fVw+lTitRtMQLY7XX3d/N+1evbYsrUmbka1jgmZivWDb+5zN0Q+/Brz01a3TR/9b0ENXUc646H70+6js03SOHirXoTmm/RmrRaZPCpjaH34C2b8XhfEqT7x0Ap8vV/00uJmrfUwP7a3X+T2UPhzY9XzYCp+3RbmepFgb/Bx/83k47v/s8ry4PE01Po/9XrG5e2787POzVEJmohp3rgYfh5989v3jPUkGOTgxf/d56s5Ln3ro/h627LIkzBXIVOPzeOV6kttaszsk6GruQX797TvbTXf0xryb7nevmwvRDgKz8WMzdnP83eumu3q3i+43n/k/6lIuWZONaoiu13/4wdnJH79HfXUqZnKd2b+D/U3qX8ufsw52+CvX7j2ahx9CHj4wvcBtPiL795A/Vomji4d+LqD+mlXCtHz31jRy1aCG+Vw1aju6WstyvLPdcNL9CHEQjMeW+Z06Vg8Y3mbWCthuJjfJcOK8RVMX9nfb8uH6cttOhgWZM06Gnz1O7svcaa3/7jHLSlnvjBSRR9PhN795f7vO/Y4sFcjl/Cfc5dr/OZ9BfCjNBo/LcacBuVuqMt9loUIYVCCXt2XB69OiKJ/Hc90ut2Olx/XF5eLy7tLlqvvFY8oBN8TWeNz9cHnn8vDD5Z3HaGONwhztNo5RFsNUzt5sGbrFy9O78x9dlu0PHkNtYCWPPxoffvSRb1bOUtJ/93GnjboR192ssxzMP8pV+AFefnRH/dEX9O+HHbou2+OvHheKPZ/N1IT9Tz7j+a+BCn4KlOc7oMIfARV4zxXs7W7E1m3f/jAx/O3/AG1pft0=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 12227264..22acf7ca 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "eJy9XV2z20aO/StbyusdRwC/XVtblTieWW9lJq44s/twK5WiJd5rJpKoJSk73lT++xabpIhGoylQ0vjJyVU3gGYfoNE43eQfq7r61KxePv6x+q08bFcv8WF1yPfF6uXq38tDW9SHfPcfq4fVqd6tXq721fa0K5qvfxl/+uXFh3a/Wz2sNru8aYpm9XK1+vNhlAWYnqV9cyy/rbafz6KGDlTU0EQQ+bA65nVxaG2rJkURTGZvqkPT1qdNW9VaZV/ZfS4pHvvSka4xnCzo+ut1D61v1lod2uLQ/vT5WCwZd9en7fvcasG2aDZ1eWzL6qC2wO5zqwXF7/n+uNOPf2p/q+Z2yWO/4Xm7HvXm8FQpNHfNvqhnnRVe6V1mXDd6GLHB8bK22f6lbP5SHj4UddkW2xusWeR51nMRve9+li3zyMkyn1fezzK9p05WSd56P4uUHjyZc995w3U4ufa+qJ+LpY79lelV9r2u9TI7vvxwLOpcgZ5zuy8WYWyNV4SYaWg3+w6zZfmSdtEW888iI4Yed9FeF/97Kpp2mQFTpzvZ0ByrQydmoRVTt6vt8PiEwj+ttl/eN25Zgu1h3s9H7rnIqGxc4juTcY7/3NmqhT41GSb51d1tW+hr1DrJ3263z1odn4v2h/pVXeRt8eO1j/G5aKt6Y2RcGanusX4Lhi1dxPX2/Hj9tJr+V8fS+RzjbV7n+wsmmTZfLH5O2q6Im/1wbti3UO03bFrm7VDvWOxnceN2ZdYm/VpCbLp9DZm1SbdLIfbctkW5YMtxV20X2TJ2uBm3XYgsa2O6UjnpcbP2pv28ZA7G5jfrVewIidp7+gWNkKf2w1/LXVvUF9cTq+UXipauzsUx0x7gtVmcYIh6D6SyoCk2p7psP7/bfCj2lxd3wZ5RQmMkqNd4r3UEJa+qQ1tXu91llNgtvwxKBJ1LUcIG6Jmj/Fh+p1tGJJPyY7lw76626s3zoapnAewxqBw73s+Wf1xwJY8lWm9S2zHk7lcAtjNnyNq1XqSzyoh5dQOou2b/EmR3Qk/7+dzd52ZDvztZUhy2x6o8tItNoR3vZUtdV/WbrtOmOF4xX6Z/afW/k2WX1ivJmvt62KHqVo7FNlR53+tOVhzz5TYMfe5lQV1tT5vlnkP63cmSutoVzTe7XfVpPpOWrDF983Pf6y26UEm5Jhq7tZTbozLJbV4PceOSabTdl8lrHI1LsxpraLdkD64li3IHpR3q0rdoTjX21qJDY5VmXZSnSbsqKq0YcLzYjqnfXSxZsiK69lyzHmqs+tC2x78X7YdqNu659nT99mO/u1iyv8KKf4UFl5JwnxXaHEFjyaUcxbXhrtov5ieCfnV2orHg2JVdiraoX//e1nkXsxeGkbOAggq4k21Ln402a1JpV+RMggULMiaNFdp8ybVkabbksQZjhPCaPau4/i3MjZQ2ndoPxaEtN2Zl/a5s8ve7pU/LlrGdZNzJxnHj9/q2tWn4yx3XKGbn02m3e7vY77peN/oes2MAyisdSSOgv++/8HCn1raeBLzBuF7Av8a6zu+vCBW3WMD2U9OW5m1dHX+ovyue8tNulqF2jXou2ik1PNbVsaq3Zzn3snTc+S050yKaOm7+7pnjk/3fD8fi8M2x/Ftx6GTPhw3e9svsA0WtS/eCzjA9M/f+VO62Q+N3x2Kz3DAjoToWh/xYNr2Eu1lX/H6s6vYm83oRd7Qvis/mvXnr5HxnA42wp3xj2yj0uAJUfCdthFrOtkx7l0+Y7FPrZ9LANduChWZpNwgLzGmqU7252qBz7xtNYiA3Da61aep+T6Oaov2+en4urgX0V03R7kYBNxuWJRAhD+F/rep9Pj22bu2X4kHf7Aov42rPNr6zMeQoZg2vUD3Nw/fV8/fFx2J31lYcTvvm6/HP8xempki1Ld6fnudkfDW2kK08myFKN0n0rPSxxTXSn/I2nx3/V2OLa6SXNGxKwmdj4rzs6ulpVnT/+zWSOycpZmWPLa6R/imvD7PChwZ62fYhvW+OR2ch7/88i2dtLkVEqdKmwSL/+vquqD8KxViqp0suxlbOoZ1jXbXFhh3auaT1+Ko6PJXPF7QeN2Or+2lt8/Jwcbid4nPDu+g+tdWbw6/Fpkv4Xx/kyoNlw6mtyrFDcXDLDNfbMm2XGnELzxA2tnU27tdbUB7Ktsx3ZXPhIdjt7qF5Vz3/1azA7u1aqnhXPT+dm91J7/MF1AkJxSJ9bH+/L7fbXfEpr4sfi+eyaS+MeGpeT82VEcXKrXqXPdXdXvkStPqGuWl4o67ZmEt1Ha/UNWFxKlu49RMZvRurxzXa65N7RIvq6n/XrgD2gvXaSnCIdPPDvRatSZh22ertunC05pWfTrSVjh0UPKJWt4emk/VeYMaW6Twn4SICvdqPtNuVdlwGy4V8+JIG33UfW8elmyiXtfS11Ytqzs30emz3+j7fv9/mngh1/vFebmYL1LraZOM1eSLTqcsW/23uzLfOpJkk0jFJk0reySR/hilapcgzbzdMmX5yA5cmoTcbqshNXYSrM9SbzbuQuDLTtOnrzWbNZ7XMKmVuew+jPCmva9ClxPcaY67Kh5lpF7Lia6xakiu7UJcz5jvaoVil/Nn0rXaoc2yvo/ky7Vst8+TfzI4LWbjoMnay4LukO/10r0SBitOmCaN1Ho9/L720iqsaGl2r40ORbz2gsNRM7a7W5D+I5yi7fPbusr6y+TZvijh8fdhUW3l9sZSWzXvTvji3v1azeICKq5s9t3FZx/+eivrzu7YuD8/zmxdLqenVmF66vYtgBXcwf94//nY/FyPy9D42GLjYyaiyy142r2XWzagilZ/N61IBn+pchPx53U2bt6fmlXRZ2FHbt93M3RP2aLQg6N+1DL/cCX5UmhJ8o2k+6OWi31iKhjZXatjku937fPObeOSXD2loO8ujX9TozVItXRfI3ota9uW+6M5/SQ5lKeoatkPDK3WJR5WZmtueWdVzz5eUDMdSrtfTFHWX1f3f5fmxWl6v7WNRf6/CQ9/2VlR8LOpGunvLlE3NFughIefbvCk34gHy8y93CTm2NFXImUzzpiZN86mq3UWBKSPtrtR0arqDCoLrME2k3QJN0nT0N9X9+vrf7zs1ROayCRqM9deXyLHo/tq/GMNFQ+ze/ZV/3SOet2p+OqkFV2qztohkFMvHfbP24aBU1/C7vM11BgydOju2fafFz1t8sYKjffrpLnBm4lRIJtZ54PKLJxfg2n5ZyNRe1uyjPLjmmReaXa3Zsx1yVQtEyGLdtsMcj7vP/9VUh7d5u3EXJ26Baf5rUx2OQ/N72eGeBvSZcPnYn0qbr8gjqLtEcyn1KSfZKLxAeMmYoneQL11d4Q3uEhJEoarA4Nh7kZr4Ka+fC3f6vCYM3dqx2212jJTuIivGTtfbwAq1QxOletr+Ns3Nh+q0275ZqL/vdZMVFOLf+/mW6ae7wJqJUwGaWOe/0eKJeFzf88WIp9L26tS01V6vc2Pa30PzcKdIr3q4PHSNbgqRv1+mm9wmd4GMR6wKOoLVs9cp+3zQrWr4bOj6PJ373MeGqu72/ctsmPrcbgN/jYDeEn4981p7rKRqu53ZW3qfyXY7Tc39rOgf81Irzr3uYMXFZGTGFvXt2VmLhOt5ngKw9etdQoErURUFbDO9aYh8ikTQKZ0cWazv1BTfWHUCjeZTU+S800IbyPS9rcvDpjyS+xqj6vMvd5k2W5pqyibTfJtbsRjCNI2NdDsrSSeLjRqls7UXcVxkSoat1LfdNU0h0tg/z06OfXGUElLit5gEyV9ZrNQsA8fM9lvhKdx6tJeb2Xd+KLWWh7z+rB+0aX6P0ao13kFX97NO2dDyFm09R6pSd256uz43D/Er9GceOo2Gp1fpG1verM2cItCN0bQ/ju1v0bwtdoVQ3ZWUnpvepM99w4Coy3+HT6dHKiRIiuZqBzpNR7HWJ+lyy3xXaKuEMpuorJopsil1nZSqTldoomue5yB2/+e7JCBElCr7GCy65ewlVbngLpKrWTzXeGmE51bXaNmWzab6WNTfHLZm4n6sTq3A9FOVY5f8sDULTD12uUb/sa42RdO8/tg1ntM6NCyGhkpdLvT6YopnF+M2uSMkHbEL4GlZ7cmSn+xb95eUn5vfqndn3YK/pHZsfbPW6vmncl80bb53j/16lVfPLel0hQ3WS0aEYgV5F8MbJQ++jIyeUbCci36zkIeeU36FossUtHK0Nyn2sc9zurXks0c9BxGrNXHN/c96EM3OGRGmmLPBspk5My1U2mjrRSrp4/quNBd6crIMU53Tz/MbZirS/zqV4Sf9k2cx2CPqUuwdLVIFXJ+O+UDrqmB7BfpWEp+K+TeTaFTw61yzmi6V4i4otG9/+jTN3//UqNCOyTS+x5j+p2w/vGvzzW86lZ/K9kMzNL9Kqf3aFy/GZ1/9olGhfZCm8Y0PsvS8o8tSNPvCGYUC7YC6treOp/mBvOLGq6iZe9HNBRUmwGiHZBrfOKZddTkk9W2uEm+/ucenYP7tPRoV2kdmGt/4yKz3BfkUzb4zSKFAO6Cu7TXjsV/25R666l/zdf77hUq5La3jwqW3lZ3/Pistti6Zn0U8nQ4mC2m+zo/lAgHCIURLlPIkoi2UfVTAEtj/tljYJTt5qwUK3C9RW5LnPkDtE8lPrFkCNRcTuTh2II3JU1zDsgW+Gz4XJgscf9UKtJiISVL3Z60I51sLk5jxpwWiBgy8mhXKGi0X7+XKJTWLDvGJ6v5hv9ReUtI3WS76LX8nuyR8bLRc/I/Sy9YlFbShVs13r79//dNrQWz/g1aM9+MWk0DeRCv6b69/EqT97fVPWgGMD5tk9D9oxRx8ADosgs3bb3569Z+CFPN3rZDudqz9dd5J0Pk3tUU/vJOecPdntT3OUQVij+qwgiXM607HhU709p/iyP6pHtjE/Qlyph+14ur807dytB9+UQvyrpD1suXROZFPJS1bGMWPQhBxV0SnrvQryTJ/l4T8/LAqD9vi99XLP8733V6u8EXwIls9rJ7KYrdtVi8fx3rbptrve3ZiW21O5j9/Hpr9d9F/NeTlY9/66/Xq4XH9EAUvIEx//vnhcexsfjB/GGVMfzEdYfXwCFJHcDqC1RFXD4/4gOGLFGKrIzod0eoYrB4eg4cwfBEnkdUxcDoGVsdw9fAYSh1Dp2NodYxWD4/RQ7h+AZFtauR0jKyO8erhMZY0xk7H2OqYrB4eE6lj4nRMrI7p6uExlaYjdTqmVsfMNx2Z0zGzAbD2zQe42AEGHvBNCQjwsfED6JsVcBEENoQg8E0MuCACG0UQ+uYGXByBDSTo4JE9hOmLdWh3dZEENpSgAwispb4umMBGEyS+yQUXT2ADClLvY3YhBTamoEMKwEOALxIWHFxUgQ0r7JACKClGF1do4wpNVAqEh4UurpDFpQ4qEEp9hchk4woDb1BzcYU2rjD0PWh0cYU2rjDyPWh0gYU2sDD2P2gXWWgjCxPvg3aRhTaysAMLRFKwQhdaaEMLM48noYsstJEVGGTFkt7ARVZgIyswyErEzi60AhtagXfNC1xoBWzV8y97wrpnQyvwrnyBC63AhlbgXfwCF1qBDa3Au/4FLrICG1mBQZa4lAUutAIbWoGBViZ2dqEV2NAKzFIoJkOBC67ABle49q0OoYut0MZW2KEFxWQqdLEV2tgKvdgKXWyFNrbCwBc+QhdbIUuqOrggikYLeZUNrrDDCwZiZxddoY2uMPaO2EVXaKMrNCtiKCp20RXa6Ao7vGAkTrKLrtBGV2jQJUaf0EVXaKMr6gCDiRD2IhddkY2uyKBLdKjIRVdkoysy6MqkIUcuvCIbXpEJXaJDRS6+IhtfUYeYAB5CfAEx2p1dfEUscfeui5GQutvwijrEBCgO2cVXZOMr6hATiOE6cvEV2fiKOsQEYryOXHxFNr6iDjGBCM7IxVdk4ys2ubwIztgFWGwDLO4gE4hLY+wCLLYBFnvDV+ziK7bxFQdef4xdfMU2vuLQl+7FLrxiG15x5PWK2MVXzPaGBl+ppFjYHdrwihOvU8QuvGIbXrGBl5Q7xS66YhtdcYeXUHTl2EVXbKMr6fASiutb4qIrsdGVgM+VExdciQ2uBL2unLjoSmx0JR1eQnGBS1x0JTa6ktAbBxIXXokNryTyxoHEhVdiwyuJvXEgcfGVsPJD4ltnEqEAYcMr6RATimt64uIrsfGVGHyJ63Li4iux8ZUafIkbitTFV2rjKzWlCDH0pS7AUhtgaQeZUAx9qQuw1AZYagAmF21cgKU2wFKT2ouZbuoCLLUBlprcXvTm1AVYagMs7SATid6cugBLbYCl3opE6gIsZSUuU5EQHTIVqlw2wNIOMpGIztQFWGoDLOsgE4nozFyAZTbAsg4ykYjOzAVYZgMsQ1/0y1x8ZTa+sg4xkYjszMVXZuMrM1UJEdmZi6/Mxldm8CUtcZkLr8yGV2bgJQI7c+GV2fDKOsTEIrAzF1+Zja+sQ0wsAjtz8ZWxMmqHmBilIQuFVF5J7RATe2qpUjGVVVPXHWhiKZfpf+LdWUF13eEmjsTuQkl1zWqqa1NUFXHW/8b7s7rqugNPLC06/U+8Oyutrjv8xBLY+p94d1ZeXZtahYi3/jfen5VY1/4a61oosq5ZlXXdwSgRy7troc66ZoXWdYekBGTkCLXWNUOeqcsnEmxBquI7ZfwOSYlUBgSxkM+AZ6rziYhbqZbPi/mmQJ+IuJXK+bye3xf0ZTZAKunzmr4p1CcyIyDV9Xlh3xTrk1RK5kGq7fPivinYJyKrIJX3eX3f1OxTEXlShZ+X+E3ZPgWxuwA8VuUHU7hPReAJZX5gdX4wtftUXM5BKPUDq/UDeredIFT7gZX7wZTwUzEhAKHiD6zkD6aMn4o5AQhVf2BlfzCl/FQOuULlH1jpH0w137PgCMV/YNV/6Mv/IncAAgEAjAEAU9RPZdcROABgJACYyn4qps4gEAHAmAAwxX15+gUqABgXAKa8LwdtgQwAxgaAqfB7grZACABjBMBU+eWgLXACwEgBMIV+OWgLtAAwXgBMrV8O2gIzAIwaAFPul4O2QA4AYwfAFPw9QVvgB4ARBGBq/p6gLVAEwDgCMGV/T9AWWAJgNAH0PIEYtAWiABhTAKb4LwdtgSoAxhWAqf/LQVtgC4DRBWAoADloC4QBMMYADAmQymOXKHQGvJ40EJ1WIA2AsQZgmIBsLc6cQBwAYw7AkAGZ7LUCdwCMPIDQW34DgT0ARh+AYQQy+dkLuGMEAhhSQC5IgcAhACMRwPACmbzgCjQCMB4BDDWQiVFDIBKAMQkQeQl2EKgEYFwCGHrAM/cCmwCMTgBDEXjmXmAUgFEKYFgCefIETgEYqQCGJ8jkdEGgFYDxCmCoAs+CIzALwKgFiLyHhEDgFoCRC2D4gkzOVgR6ARi/AIYyyMRaBAgMAzCKAQxt4In5AssAjGYAwxxkcrYhEA3AmAboqQbxOIzANQAjG8DwB5m8QxXoBmB8A8T9CSKxKgIC5wCMdADDI8BaPu0n8A7AiAcwZAKsxdIdCOQDMPYBDKEAazFnEfgHYAQEJP58T2AggFEQ0HMQaznfF2gIYDwEGGoB1rIHC1QEMC4CDL0Aa9mHBDoCGB8BhmLwPAEBg4yRAEMywFos0gicBDBSAgzPILuAwEoAoyUg6REoFnkEZgIYNQFJD0Bx8RXICWDsBBjCQeTsQKAngPETkPrhJxAUwBgKSHsKTHZggaQAxlKAIR482zWBpwBGVIDhHjzbNYGqAMZVQNoHQDmACHQFML4CUm9BGQTCAhhjAWmPPjn+CKQFMNYCDBMBIKc/AnMBjLoAw0bIxC0I5AUw9gJS/wos0BfA+AswlASAHMAECgMYhwFZD0E5gAk0BjAeAwYiQw5gApcBjMyArD+rJGcBAp8BjNCAbKbcJ1AawDgNyPzbD4HVAEZrQNZjUM4iBGYDGLUBWY9BOQ8Q2A1g9AYYxgLkA24gMBzAKA7IZva+AssBjObAtTcMosByIGM50NAWIJ+TQ4HnQMZz4LoPg2IYQIHpQMZ0oGEuQD63hgLVgYzqQMNdgHz+DAWyAxnZgYa9AJQPzwp0BzK6A9f9qV/RD1HgO5DxHbjuS3+iH6LAeCBjPNBQGB4UCMd/GeOBhsEA+TwbCpQHMsoDoT9gLvoRCqQHMtIDoT9kLhVhUGA9kLEeCP4bMALrgYz1QENjQCC7gcB7IOM9ELzbERRoD2S0BxoaAwLZiwTeAxnvgf2NhkD2IoH4QEZ8ICTe3QAKzAcy5gMNlQGB7IUC94GM+0BDZsjlBBTID+RXHPo7DoHsxdItB37NYbjnEIuXFQQIOlcd0FvPQPG2A8Mg9hiUg4B05YHfeTCEBgSyF0v3HvjFh/7mg1hOQ+nuA7/80N9+kE+0oXT/gV+A6CmQUKqlonQHgl+C6G9BhFJNCKVrEPwehKE0IBSdQLoLwSgQ7G9DhOJ9F4EDQcaBYH8hQj51hQILgowFQf+lCBRIEGQkCPYkiJiMoMCCIGNBMOjPf8oLocCDIONB0BAbIB/+QoEJQcaEYNBDUPYBgQtBxoVgf1VCPgSGAhmCjAzBwL8UC1wIMi4EDbcBkbgQClwIMi4EDbkBkehCAhmCjAxBw26AfCIMBToEGR2Cht8A+VQYCoQIMkIE+wsUYlkEBUYEGSOCoX8pFhgRZIwIhpG3LIICJYKMEsEw9pZFUKBEkFEiaCgOkA/GocCJIONE0JAcnvELAGScCIY9AOUYJLAiyFgRjHoEykFAoEWQ0SIY9RCUg4DAiyDjRTBCvw8JxAgyYgQN0+HxIYEZQcaMoGE6xHNrKBAjyIgR7C9aRHIME5gRZMwIRv6TCChQI8ioEYx6CMoxUOBGkHEjaLgOkM8MokCOICNH0LAd4uE7FMgRZOQIxv2tRDmdF9gRZOwIGrZDPL2HAjmCjBxBQ3ZALAdRgR1Bxo6gYTsgloOoQI8go0ewp0diOYoIBAkyggQN4QGxHAYEhgQZQ4KG8BBPIKLAjyDjR7DnR+QTkCjwI8j4ETR0h3iEEQV2BBk7gj07EstBSKBHkNEjmPQYlL1YIEiQESTYEyTyKUoUCBJkBAn2BEkie6FAkCAjSLAnSBLZjQSCBBlBgj1BIt6bQIEhQcaQYM+QJLIfCRQJMooEE+9FfxQoEmQUCRrKQzxcgQJDgowhQcN4iPw8CgQJMoIEDeMBiRwEBIoEGUWChvPwbKkFjgQZR4KG8pCvZKFAkSCjSLCnSBI5CAkcCTKOBNMegJ5r7QIAGUmCPUmSyFFEIEmQkSSY9giUw4BAkyCjSbCnSRI5DAg0CTKaBHuaRN6UCywJMpYEZ1gSFFgSZCwJppl/Ty7QJMhoEuxpErmsIrAkyFgSNKSHfN8MBZIEGUmCPUki1wQEjgQZR4I9R5LIYVjgSJBxJJiF/qKCwJEg40gwi/ylUYEkQUaSoOE85JtvKHAkyDgS7DkSuaghUCTIKBLsKZJUXoYEigQZRYKG8oBUXoYEjgQZRxKs/a8/CQSSJGAkSWA4D5mqDQSOJGAcSWAoD/n6YCBQJAGjSIKeIknFZTAQKJLxb+YVVx+Lui22b/pXXT0+Th8T/2P1y/ACrI4GN6q6d2F1RPfLP/78c3rl1cs//iRvvep+67QNn2QjUgKYpHQFco0U9n1HIm16J/ofq46yWSBtfOM+lRZRaZFWmvulRSozpjJjnczuTbJERkKefJd/KWXkxyMVE2dk/vSW9K8TJdYQKUtk9K/OnuSkk5xUK2dDXjtLnw/FVKLE1LHcFs2mLo/9u2YncRRTYaIVNrw1nowvIA8K1Y+qHF7WS+whqAzTvmcc9P92yfAiwb4niPQJKpF/LHf5/v02ZzhLUzrwTCuLRwrqOKFaSjW9PZgMj0aueHxyag84y+QQBhp9cJgZ9YQc+9dA0lmYxAVqwBgx3LKIYCZTizq/BZJMJg0aYTg+O7VbDCK5fUiGGq377kuEji+ZnCRmZC66Q8yDoerQ0pzfwUwnJKBuoQZhM3zibJJEI3h3ldB0BfUkHzfD16qIRBqH19kocRh4d5BYL7rNywOzl8SD7u7hIF0bWo+7z7821WH4Bh7NIajVqdJVrK/8UK+mgaZHz8OqK7UvlFpWh23ZDG+ln+SHZPK1OPJ+fomanVCzo9Fs5bM950GOS5FHGyqBRb9nTnMWup6u9bKGT/sQSTQOoTaK0y+cU6voGrVWZkGntioPvxbmPa/nLw8QnNNFGmDEuQ6Y3QdzrRAU02VmrZbBPrpLk2Uaf0C3YJEP6VLQ0YHGQ7jozmcsEilk4Gs6aGXuRT+6S0dLl1PQeRwXktFAG8ZjNBwXLhhHniqnp/9+LjWSIhoXSKmOxaFbG47FxlqpCapT3Zg3+W73Pt/8xiNLRgNLrHNb87JjKoTgZMgxx/CvjP5GovVdQxKjSMSOlAZOn7ekiRfdVSnd9SyJba8SmuLAsIx09/8WCrWTYIpDGBd8ZVz2PT0y5r7nuOyPa98wY2MWEI7/Dn4QD/+fjoNcj/8xZq/dhdvB1Gj0nREG0Vnb2CYZ3ArS8S/p2CYb17X1evyPdPTBMTkLzv+hxP35AxLkmZDJG7O+eNStLFJ0GVBxaLvPvljrP1lPh1ENC4QecMJeKyA+EI8BSplbThKlZ9EV0SeEpLoVchI5W8ZIaNhLlZHgLNrJVUiUUeZrk7BD5axuCQ0HyrRyEjh9IICKTKjIpTaal9Pn47vrqdiUitWt6JPYpvsYgxW76K4Hzk681Nw2r823sWmmTiVnumA4fA2QlJxIyMrGpTfSzY/9wT+aU9JHGOmGOn7OnC7kGV3IzyFDlxF5SkfEScbwOc7JGP2GUKKcIt+XlulSSIGqFcvKGLS+iDpQSjNDl3dc60Jacdgeq/LQysEypShEXdgZJc7Fs5DIVcbeUSyPZQF5/sqkaxS1L9oPlfUI04iOV+cotjRTDir4li6lWTrqQDLKtdNDApVo2XxIQYYOV1mncgqtMd3ajOkG4Fjni5R4tr7FScMNjRORLjzMQY8SIOO+JB7zsHQME8qtAFfEdsx0+7hWzhb7QCgRF9MwoSwwFb/n++POirwEimP6M+atyqn6/birtnY0J5EnUM7R78eqbn27MvLkUmV86D8IbUkhoSFTOjP/rDTdatONSnJeUHQPbfgYK5kGGlrXMHqLbrD2B1cpRmjpSFkDGb+FTJ2OQi04Zw66lPbptNvxRCkkkUa59+fBKqRDw3HLpUTHc9FaCeexqrfFU37aWTpCMsPKNLYTfGraai8xthQwmc4tnot2MEwQiHRXm+kiwHMhSaIO2124VEqq6k1d5G0xx8pQ7CgTdyJZ4EDA2vtcKdBJG2gY1AFy/PAcTWLpxgdHJ1am6708a8nIaH0+HFelaMyOUeeAH9r26OY2NOGOzxUR3fMsPdVHGqcx1FlXetj/iO6elcRvuSUfo6ey6LxEuukoBTehKwgqK2YcaTFNstZjzUWZqlofoqZxnhajYuWDP5Rtme86qm3a0VpZKkXfWKoF7bSepdsVfjr6MdEAZaZxzqzs2EWT6UxrXVvUB3sFJnFKiZBzcj+kCXZmSQGsDAFlYxEQViigFGA4ToYymx4+K04BQz011uWiMocY011mohun+fi47Vl0NQ/HIqVyS2N/y5zaRmOI8iiA+WA5lUGXm1i3gO2q5yeDBysM0bJY9xLVAftjWFempJ1sN0Ojp4m6Q+VKSSzA0Spb95rWwcJxdVAGll317EwwTUSVmcqueu4+BNm0+f5oY4UGO2UNf1/UzwUPxTQfG9dUXf5oxI3nHuxdHpnkQOcN7tpMK0Cx1qJOCOegaJKs9M19ud3uik95XdTFc9m0DMM0UYTzhvHMM4x7AyU7tS/3hfm+uzUtVIcyNjm0Pl27zhuW/t9wWHbGPCoZErVsLA7Go28mY9Vi9FY8n7lRZkpudTwg6I0G+cmYBiiLLiyaxzSwKAsLw07beu7UH5SRbhDjHogBeqYI17r8bZDmxjda9VFuTwZZz8Wh25iwpZmgQ1n1d9d6C7MhmVUl7T6VBqtTvbFrMsT/lRvFY940n6raXv/WtKigXBXcFZ6ODXEsdCgzLb7zp2coomHpOxOXytS8kykc16NLYKacg4rtLekpI8QxcCiXZvKdbLoppMUTOG8Kdf51rKtN0TTFx+6PlqE07VLmzxKzRk95RMPcnk9BKV3teGK20bRrpLBRCWTz2W37AdJIomQdjBQXI/QcACrzkEmUvdBT5hiV5ICR1bR1eXiWmYGMVs+VO8w6/+Qc3qF7N8x0KYRUa7EOeQ0TOa76eC6TD8tXsNb576DIUGi8gkIVgs5HBnG+cwNkcVSeQOgEljXbS5DoojwgIZ2LTWmGPcZSSMeKu/J03yjZN2SiRHnuQM5lrfNuw+zrvNgw7pZN9IKBzod9rD098zWeghkztUB5ErE+WUxxSnfXeD50o7NzPKvcHzB1DlcQ0aEuSjRF3ZVOeEVsbZ2b14Vm9+wz0No7Ks8892KEitia5tmxDhtUmJA40qo7KtmjRqpq05MJ4wEoUJagm6KVwiGNh6DMHI0oNxIA9S5QHnRoPlSn3dZTB6OhRZn/uKknLZVqhbR5e2o2jAPMaKVPSdQ27WebnKQMR6BbxbqagR25qXMHyu1Rl+PbKTl9uutxF6j0QiNNLFDRwrTSfXi0J4adT0v2/yoPTZ6awj4pb2cA1B1BLbF2duRrCgjltbmPRd04t4eoD8a6pfhTXltCaNES1mO6u0CYOJk0T9WUbX5+WB3LY7ErD8Xq5ePPf/75/xwx90E="; \ No newline at end of file +window.searchData = "eJy9fW2z20aO7l+5dfL1rEcA3123tipxPLO+lZ24kuzdD65UipF4jjmjI2pJyo5vKv/9FrtJEY1GU6CkyScfi90AyH6ARuPpJn9/aJvP3cPrD78//LM+7B5e4+PDoXypHl4//O/60Fftodz/+8Pjw6ndP7x+eGl2p33V/eWX6dIvrz72L/uHx4ftvuy6qnt4/fDwx+MkCzA/S/v6WH/T7L6cRY0dqKixiSDy8eFYttWhd62aFSUwm71tDl3fnrZ902qVfeX2uaR46kvvdIPxbMHQX697bH2z1ubQV4f+py/Has19D3162+dWC3ZVt23rY183B7UFbp9bLah+K1+Oe/39z+1v1dyveew3PG/fo94dnhqF5qHZn+pZZ4VXepe5rxs9jNjgeVnf7f6t7v6tPnys2rqvdjdYs8rznOciet/9LFvnkbNlIa+8n2V6T52tkrz1fhYpPXg2577jhpt4du2Xqn2u1jr2V6ZXbXtd62VufPn+WLWlAj3ndn9ahHE1XhFi5lu72XeYLeuntIu2mH9WGTH2uIv2tvqfU9X16wyYO93Jhu7YHAYxK62Yu11tR8AnFP7ptP3zfeOWKdi9zfv5yD0nGZWNa3xnNs7znztbtdKnZsMkv7q7bSt9jVon+dvt9jmz43PVf9++aauyr3649jE+V33Tbo2MKyPVPeZvwbC1k7jenh+uH1bT/+pYupxjvC/b8uWCSabNnxY/Z21XxE17OzesW6j2GxYty3aoVyzus7hxubJok34uITbdPocs2qRbpRB7bluiXLDluG92q2yZOtyM2yFE1q0xXamc9LhZe9d/WTMGU/Ob9SpWhETtPf2CRshT//Gv9b6v2ovzidPyT4qWvs7VMdO9wWuzOMEQ9RpIZUFXbU9t3X/5cfuxerk8uQv2TBI6I0E9xwetIyh50xz6ttnvL6PEbfnnoETQuRYl7AYDY1Qe629104hkUnmsV67d1Va9ez407SKAAwbVU8f72fL3C64UsETrTWo7xtz9CsAO5oxZu9aLdFYZMW9uAPXQ7F+C7EHo6WU5dw+52djvTpZUh92xqQ/9alNox3vZ0rZN+27otK2OV4yX6V87/e9k2aX5SrLmvh52aIaZY7UNTWl73cmKY7nehrHPvSxom91pu95zSL87WdI2+6r7er9vPi9n0pI1pm957nu9RRcqKddEY7+WcntUJrnN2zFuXDKNtvtz8hpP49qsxrm1W7IH35JVuYPSDnXpWzSnmXpr0aGxSjMvysOknRWVVow4Xm3H3O8ulqyZEX17rpkPNVZ97Pvjf1b9x2Yx7vn2DP1epn53seTlCiv+FRZcSsJDVmhzBI0ll3IU34a7ar+Ynwj61dmJxoLjUHap+qp9+1vflkPMXhlGzgIqKuBOtq19NtqsSaVdkTMJFqzImDRWaPMl35K12VLAGkwR4mvWrOL8tzI3Utp06j9Wh77empn127orf92vfVqujN0s4042Tgu/t7fNTeMvd5yjmJ1Pp/3+/Wq/G3rd6HvMjhEob3QkjYB+23/l5k6tbZYEvME4K+BfY93g91eEilssYOupeUnzvm2O37ffVk/lab/IUPtGPVf9nBoe2+bYtLuznHtZOq381uxpEU2dFn/3zPHJ+u/7Y3X4+lj/rToMspfDBm/756wDRa1r14LebQZG7tdTvd+NjX88Vtv1hhkJzbE6lMe6sxLuZl3127Fp+5vMsyLuaF+Sns17997L+c4GGmFP5da1UehxBaj4StoIdZxtnfYhnzDZp9bPpBvXLAtWmqVdIKwwp2tO7fZqg869bzSJgdw0uNamufs9jeqq/rvm+bm6FtBfdVW/nwTcbFiRQYI8hP+1aV/K+bENc78UD2yzK7yMqz3b+KOLIU8xa3iF6nkcvmuev6s+Vfuztupweun+Mv28fGBqjlS76tfT85KMr6YWspVnM0TpJolelD61uEb6U9mXi/f/1dTiGuk1DZuS8MWYuCy7eXpaFG2vXyN5cJJqUfbU4hrpn8v2sCh8bKCX7W7S+/p49CZy+/MinrW5FBGlSptGi8Lz649V+0koxlI9Q3IxtfI27Rzbpq+2bNPOJa3HN83hqX6+oPW4nVrdT2tf1oeLtzsoPje8i+5T37w7/KPaDgn/24NceXBsOPVNPXWoDn6Z4Xpb5uVSJy7hGcKmtt7C/XoL6kPd1+W+7i48BLfdPTTvm+e/mhnYP11LFe+b56dzszvpfb6AOiGhWKWPre9f6t1uX30u2+qH6rnu+gt3PDdv5+bKiOLkVtZlT+2wVr4ELduwNA1v1LUYc6mu45W6ZizOZQu/fiKjd+v0uEZ7e/K3aFFd9rp2BnAnrLdOgkOkmwv3mrRmYdppy9p1YWvNmzCd6CqdOih4RK3uAE0n673AjK3TeU7CRQQGtR9ptyvtuAyWC/nwJQ2h4z6ujksnUS5rsbXVi2rOzfR6XPf6rnz5dVcGItT54r3czBWodbXZxmvyRKZTly3+r6U93zqTFpJIzyRNKnknk8IZpmiVIs+83TBl+skNXJuE3myoIjf1Ea7OUG8270LiykzTpq83m7Wc1TKrlLntPYwKpLy+QZcS32uMuSofZqZdyIqvsWpNruxDXc6Y72iHYpYKZ9M322G4sf8oD7tAPscNMe0/ntuvmt+uy+6DLh7K8W99JoHMn9lxIf8XndVNU0LHg+dL90pRqDhtgjJZF4g1v0qvy+KqxkbX6vhYlbsAKBw1c7urNYW3AHrKLu/6u6yv7r4puyqN3x62zU6e2RyldferaV+d21+rWdy6xdUt7hi5rON/TlX75ce+rQ/Py8smR6np1ZleulWTYAV3sPCKY7p2Pxcj8vQ+Nhq42smosstetqxl0c2oIpWfLetSAZ/qXIX8Zd1dX/an7o10TNlTa9tul04oBzQ6EAyvl8Yrd4IflaYE32RaCHql6DeOorHNlRq25X7/a7n9p7jZmN/S2HaRwb+oMZgfO7ou0MwXtbzUL9Ww80xyKEfR0LAfG16pS9wkzdTc9sway3pfUjJuiLleT1e1Q1b3/y6Pj9Pyem2fqvY7FR5s21tR8alqO+nUL1M2N1uhh4Scb8qu3opb189X7hJyXGmqkDObFkxNuu5z0/qTAlNG2l2p6dQNWyQE12GaSLsVmqThsGfkw/rs9fsODZG5boBGY8OVLbIh275wQIzhoiFub/uyAd0jXrZqeTipBVdqc5aI5C7W3/fN2sctWkPDb8u+1Bkwdhrs2NlOq5+3+EoHT/t86S5wZuJUSCbWBeDySyAX4Np+WckRX9YcIlu45oVXqV2tObAc8lULFMxq3a7DHI/7L/+naw7vy37rT07cAtP8H11zOI7N72WHvw8xZMLlDYcqbaEij6DuEsGm1KccZKPwAtUmY4qefr50aIY3uEtIEIWqAoNn70VS5Keyfa784QuaMHbrp2632TGRyausmDpdbwMr1I5NlOpp+9s0dx+b0373bqV+2+smKyjEvwszPfOlu8CaiVMBmlgXPksTiHhc3/PFiKfS9ubU9c2LXufWtL+H5vE0k171eGzpGt0UIv95mejym9wFMgGxKugIVi8e5LT5oF/VCNkw9Hk697mPDU07rPvX2TD3ud0G/gIDvSX8YOi19jhJ1W63sLYMPpPdbh6a+1lhH/NaK8697mDFxWRkwRb1ud1Fi4SDgYECsHP1LqHAl6iKAq6ZwTRE3r8i6JT2rKzWd+qqr506gUbzqatK3mmlDWT43rf1YVsfyUmRSfX5yl2GzZWmGrLZtNDiViyGME1TI93KStLJYqNG6WLtRbwvMiTjUuqb4YCoEGncy4uD4x5ZpYSU+BUoQfJXDiu1yMAxs8NWBAq3Ae31dvFtI0qt9aFsv+hv2jS/x92qNd5B13BZp2xseYs2y5Gq1J2b3q7Pz0PCCsOZh06j4elV+qaWN2szuwh092jaH6f2t2jeVftKqO5KSs9Nb9Lnv9tA1BU+PajTIxUSJEVLtQOdpqNY65N0+WW+K7Q1QplNVNYsFNmUuk5KVacrNNE5L7AF3P58lwSEiFJlH6NFt+z6pCpXnILyNYs7Ki/d4bnVNVp2dbdtPlXt14edGbgfmlMvMP1U5dSlPOzMBNNOXa7Rf2ybbdV1bz8NjZe0jg2rsaFSlw89W0wJrGL8JneEpCd2BTwdqwNZ8pN73v+S8nPzW/XunfP3l9ROrW/W2jz/VL9UXV+++BuOg8qb5550usIG5/UmQrGCvAXinZIHX0dGLyhYz0W/W8lDLym/QtFlClp5tzcpDrHPS7q15HNAPQcRqzVxzfayHkSLY0aEKcZstGxhzEwLlTbaepVK+ri+rc1RopJMw1TnfHl5wUxFhl/kMl7SP3kWgwOiLsXeySJVwA3pWA60vgq2VqDvQwmpWH4nikYFP0i2qOlSKe6CQvfcaUjT8slTjQrtPZnG97in/677jz/25fafOpWf6/5jNza/Sqn7wpkgxhdfOqNRoX2QpvGND7IOvB3MUbT4qhuFAu0NDW1vvZ/ue/JynaCibukVOxdUmACjvSXT+MZ72jeXQ5Jtc5V4951BIQXL7w3SqNA+MtP4xkfmvKkopGjxbUUKBdobGtpecz/ua8b8TVf2BWPn3y9Uyl1p07G2mh8ZtEL55etk8z1TTLbmcJwnu3kW3+92/n2VtL+Xff2pClrKLy/KTp0j/2dJT6eDycy6v5THeoUAYWOmI0q5O9MVyj7x4Ai011YLu2Qnb7VCgf9dcEfy0ufAQyL5ODsC14+yt0mPyVMcTXMF/jh+vE0WOF3VCnTYmVnS8LNWhPfli1nMdGmFqBEDbxaFskbrxQf3D0hqVm1sFNX93f3EgKTENlkv+j1/Q74kfGq0XvwP0qvvJRW0oVbNt2+/e/vTW0GsvaAVE/zUyCyQN9GK/tvbnwRpf3v7k1YA4whnGfaCVswhBKDDKti8//qnN/8hSDG/a4UMJ4bdbyXPgs7X1BZ9/6P0hIef1fZ42zeIPaoNHI6woDsdVzrR+/8S7+y/1Dc286GCnPmiVlxbfv5GjvbjFbWg4AzZrpsevVMKVNK6iVH8RAcRd0V0GsrhkizzuyTk58eH+rCrfnt4/fv5DODrB3wVvSoeHh+e6mq/6x5ef5hqkNvm5cUyNrtmezJ//jw2+7+V/YbL6w+29V82D48fNo9J9Aqz4uefHz9Mnc0F88MkY/7FdISHxw8gdQSvIzgd8eHxAz5i/KqIM6cjeh3R6Rg9PH6IHuP4Vb5JnY6R1zFyOsYPjx9iqWPsdYydjsnD44fkMd68wtztmHgdE6dj+vD4IZU0pl7H1OmYPTx+yKSOmdcxczrmD48fcmk4cq9j7nQsQsNReB0LFwCb0HiAjx1g4IHQkIAAHxc/gKFRAR9B4EIIotDAgA8icFEEcWhswMcRuECCAR7FY5y/ggzcvj6UwMUSDAiBjdjZhxO4eIIsNLzgIwpcSEEefNA+qMBFFQxYAXiM8FXBbPZxBS6wcMAKoKQYfWShiyw0cSmSnhb60EIWmga0QCx2FqKTiy2MgoHNxxa62MI49KjRxxa62MIk9KjRxxa62MI0/Kh9bKGLLczCj9oHF7rgwgEvkEgRC310oYsuLELuhD660EVXZNCVSoojH12Ri67IoCsTO/voilx0RcGZL/LBFbG5Lzz5CbOfC64oOP9FPrgiF1xRcAqMfHBFLrii4CwY+diKXGxFBlvihBb52IpcbEUGW4XY2cdW5GIrMhOimBJFPrgiF1zxJjRHxD62Yhdb8YAWFFOq2MdW7GIrDmIr9rEVu9iKo1AAiX1sxSy1GuCCKBotZFcuuOIBLxiJnX10xS664jR4xz66YhddsZkVY1Gxj67YRVc84AUTcZB9dMUuumKDLjH6xD66YhddyQAYzKS4l/jwSlx4JQZeokclPrwSF16JgVch3XPi4ytx8ZWY2CV6VOIDLHEBlgyQieAxxldYRG5nH2AJy9+DU2MiZPAuvpIBMhGKt+wDLHEBlgyQicR4nfgAS1yAJQNkIjFgJz7AEhdgyQCZSERn4gMscQGWmpReRGfqAyx1AZYOkInEuTH1AZa6AEuD8Sv18ZW6+EqjoEOmPr5SF19pHEz5Uh9fqYuvNAm6ReoDLGVrRAOwXNQsLBNdgKVZ0C1SH2CpC7DUAEzMn1IfYKkLsHSATCx6c+oDLHUBlg2QicU5LvMBlrkAyyDkzZmPr8zFV4ZBb858gGUuwLIBMrE4yWU+wDIXYFkcDAWZD7DMBViWBENB5gMscwGWpcFQkPkAy1ghIgvONZlQi3ABlg2QicWJPfMBlrkAywzAxMk58wGWuQDLDcDEZUXuAyx3AZabqoQY/nIfYbmLsHzATCyGv9xHWO4iLDcIk+s3PsJyF2G5ye/FdDf3EZa7CMtNgi+6c+4jLHcRlg+YSUR3zn2E5S7C8mBpIvcBlrNqlylNiB6ZCwUvF2D5AJlERGfuAyx3AVYMkElEdBY+wAoXYMUAmUREZ+EDrHABVmAo/BU+vgoXX8WAmEREduHjq3DxVZjihIjswsdX4eKrMPgSZ7nCx1fh4qsw+BKRXfj4Klx8FQNkUhHZhQ+wwgVYMUAmFZFd+AArWEl1gEyK4j0LVVVeVh0wkwYKq1JllZVWNwNsUjGjsdd4f1Ze3QzQSRO5v1Bh3bAS68bUWEWs2Wu8PyuzbgYApeLMY6/x/qzUuhkwlIqIs9d4f1Zu3ZiyhQg6e433ZxXXTbjkuhFqrhtWdN0MWMrkcu9GqLtuWOF1M8ApAxk+Qu11w+BnKvWZCF6QCvteZX+AUyZWBUEs7jP4mYp9JsNXKvDzCr+p2mcyfKUiP6/y2zK/zBFIhX5e6TfV+0zmCaRiP6/2mwJ+lkuZPUj1fl7wN0X8TOYapJo/L/qbQn4u40+q+/PCvynm5yD3F/DHiv9g6vm5jD+h/A+s/g+mpJ+LszsIDAAwCgAwuBIFgQMARgKAKeznYn4AAg8AjAgAU9zPxRQBBC4AGBkApsCfy9FX4AOAEQJgavyB2UegBIBxAmBJAZFRAIEVAEYLgKn057L7CMQAMGYATLU/FzNpEMgBYOwAmIK/PPwCPQCMHwBT8g9Eb4EhAEYRgCn7B6K3wBIAownAlP4D0VtgCoBRBWDK/4HoLbAFwOgCMBRAIHoLjAEwygAMDRCI3gJrAIw2AMMEBKK3QBwAYw7AkAGB6C1wB8DIAzB8QCB6C/QBMP4ALIEgR2+BQgDGIYChBQLRW2ARgNEIYKiBXE5+BCYBGJUAhh4IRH+BTQBGJ4BhCALRXyAUgDEKYEiCInD/Av4YqQBhVgEEWgEYrwCGKijEshwIzAIwagEMW1CIZSoQyAVg7AIYwkCu7IHALwAjGMBwBoXs/gLFAIxjAEMbyMUuEFgGYDQDGOagkGdPgWgAxjSAIQ8KOXwIXAMwsgEMfyAPv8A2AKMbwFAIgeEXGAdglAMYFiEw/ALpAIx1AEMkhIZPgB8jHsBwCYWcPAjUAzDuAZKFtYfAPgCjHyANT74C/wCMgADDKRRioQIECgIYBwGGVyjk3EGgIYDxEGCohcDkITARwKgIMOxCIQdfgYwAxkZAGqS7QKAjgPERkNqNRmLFBARKAhgnAYZmgI28K1CgJYDxEmCoBtiIdT0QqAlg3AQYugE2cvYv0BPA+AkwlANs5ARGoCiAcRRgeIfAhisBgoymAMM8wEbO/wWmAhhVAYZ9gI3swwJbAYyuAMNAwEb2IoGxAEZZgGEhAk9AQCEjLSCzKJTrNwJvAYy4AMNFyF4gMBfAqAvILAblOVRgL4DRF5DZrW9yDiIwGMAoDDCshEwMgkBiAGMxIA9DUKAxgPEYkNs6s+zFApUBjMsAQ08EloACmwGMzgDDUASWgAKhAYzRgNyGQTmKCKQGMFYDLK0RGAABgYzYgNwiUI5CArkBjN0AQ1gAyHmQQHAAYzjAkBYyPQwCxwGM5IAiPBELLAcwmgMKy9TKUUxgOoBRHTByHXIUE+gOYHwHFHZPkxzFBMoDGOcBhsYAeQcaCLQHMN4DDJURWIkKzAcw6gOK8EpE4D6AkR9QWAzKyYTAfwAjQMBwGiBvhAOBAwFGgoDhNUDe0AYCDwKMCEFDbMhraRSIEGRECG6CcRAFHgQZD4KG1wB5bxsKRAgyIgQ3Ng6KYQAFJgQZE4KG2QB5nxoKVAgyKgQNtQEo77IVuBBkXAhu7P5g0Q9RIEOQkSG4seVA0Q9RoEOQ0SG4sTAU/RAFPgQZH4Kb4AEHFOgQZHQIgt2MLvoRCnwIMj4EwW5IF/0IBUIEGSGChuCASKypoMCIIGNEEMIb0wVCBBkhgobggEj2A4ERQcaIIIQ3qAuECDJCBO35h0h2I4ERQcaIINh96rIbCZQIMkoEIQ8vClDgRJBxImhPQ0SyHwqkCPITEYbkkAsLKJ2J4IcixlMRsh9L5yK8gxEWhCIri+LZCAZCw3PIpQ2UzkfwAxJoUSjHAemQBD8lYY9JRLIjSycl+FEJe1YiFvN6lE5L8OMSlhqRd7+hdGKCH5mwZyZisTqK0qkJfmzCkB0Qy0c2pKMTjB1Be3gilj1B4EeQ8SNoD1DEYoUOBYIEGUGCkT2iIyNZYEiQMSQYLRzTkc7pMBxagkROSgSCBBlBgobwAHmfGAoMCTKGBCMLQ9kRBIoEGUWC9miFvF8MBY4EGUeC9niFvGcMBZIEGUmCUXhKFjgSZBwJGs4DEnlCFEgSZCQJGtJjeBWLKEAAIWNJ0LAeIG8hQ4EmQUaToD1yIW8jQ4EnQcaTYByHqyQoECXIiBKMw5OywJMg40kwTsNVEhSYEmRMCcZZuEqCAlWCjCrB2KJQnlMFrgQZV4Jx8IgiClQJMqoEE4tCORAJXAkyrgQTi0I5EghkCTKyBBOLQjkSCGwJMrYEk2jBkQS6BBldgob/CDmSQJggI0zQECDyTjkUCBNkhAkaAgTkHYIoMCbIGBM0DIi83QEFxgQZY4KGAQF5lyEKlAkyygQNBQLyTkMUOBNknAkaEkTe7ocCaYKMNEFDgkAqp/cCa4KMNcE0vF8QBdYEGWuChgWBVA6mAm2CjDZBe4QjlYOpwJsg403Q8iapHEoE5gQZc4KWOZH3PKLAnCBjTtAQIfKeRxSIE2TECVriJJVjiUCcICNO0PAg8qZJFHgTZLwJWt4klWORwJsg403QHu6Qt12iwJwgY07QMieZ7IkCc4KMOUHLnGSyJwrMCTLmBC1zksmeJDAnyJgTNFQIZLInCNwJMu4ELXeSyZ4gcCfIuBO03Ekme4LAniBjTzALH45EgTxBRp6gJU8y2ZME8gQZeYL5Jvi2BBTIE2TkCRo2RN5AggJ7gow9QUOGyDsQUCBPkJEnaMmTTPZkgT1Bxp6gYUMCpQKBPUHGnmAePtOGAnmCjDzB3GJQjgQCe4KMPUHLnmRyJBDYE2TsCVr2JJcjgcCeIGNP0LAhkMuRQKBPkNEnaPgQyOVIIBAoyAgUtARKoNYgECjICBQ0fIhMAKHAnyDjT9DyJ4FSg8CfIONP0PIngYKRwJ8g40/Q8CHyiT0U+BNk/AkW6UKtQ2BQkDEoaBkUeScxCgwKMgYFLYMSKJYIDAoyBgUtgxKo/AoMCjIGJTKMiHx8MBIYlIgxKNFmoVoTCRxKxDiUyHIo8nboSOBQIsahRJZDkfdDRwKHEjEOJRo5FPENFgKFEjEKJTKMiExGRwKDEjEGJdqED2FGAoESMQIlsgSKvKE7EgiU6TfzyrBPVdtXu3f21WEfPswfrP/94ZfxhWID0W9UDe8WG6j817//8cf8CrHXv/9B3iI2XBu0jZ/9I1IinKUMBIBGCvuGKJGGCZG2SdZIm77qQKWlVFqqleZ/zZPKzKjMTCdzeDMvkZHFREamtOtYl8cjFZMWZPy0d3es7etZiTVEyhoZ9vXss5x8lpNr5WzJa3zp86EoyNTPeFd127Y+2nf3zuKQPO1YLWz8MgG5v4g8KFQ/qnp8+TGxh9xdnNueaWT/HdLiVYJDT5AiPyu0MvfmJdkMZ3lOb1wti0cK6oyxWkozv42Z3N6GWJSOTy7frJbJIQzUL3EcGWVIO9ZH+1pNOgqzuEgNGCOGW5YQzBRqUee3as6CCvro4mR6dmtFcvtoVEw2trveceeXdhJDyR0Pu7VHQ3XTVHmsu/M7remA0OCdR3pZ9jN6s6SMPsbN6MSgHuTjdvwiGpFI4/CmmCSOKBw2TOtF92V9YPaSWXo4uDlK1z6B4/7LP7rmMH5nkeYQVG6unK+dL0lRr6YTWjY+1IE/WCm1bg67uhu/fDDLj0kA14bZ4Ce+qNk0PmZTOIqVceOcB3kuRQARK4F1Fta5OQvN0TZKF5o/H0UkJXReSZQR95ycMasiapUSiqe+qQ//qMx7c89ftyA4p5M0wIRz3VgMH2V2QlBGpxndEAgfdqbJMp1gQBcfyceaKehiCrrRoYftJ6tEChn4ht50pnxw5MPO9G5pGge6AMaFFDQs2uxtiIbTxIXTnedKS+03mqmRFNHKtM5IaY7VYZgbjtXWmamJr+W64diW+/2v5fafPLIUNLCkOrc1L4+mQohDjJPoFP6V0d9IdL6dSWIUsTDRPTvyCVWaeNGJOdLNI2dJbHmV0WkEJsjEumBFhLpJMJ3wYZrwlXE59PTIPdue07Q/Go3jiE1ZQDz9O04y6fj/fLrJzfTHlL0Ox5RHU9PJd+Lxj3S6lE1xMhvdCvLpl2JqU0zz2gamP4op6EzJWXT+Q+fr81c+yDMhg5dMKfg5TVUDo68O/fA1HWf+J/PpeFfjvSjnB3mtFREfSKeHrFyMzBKlZzHU0km6qsuDZpGLZQzqJJjrZqJZtJerkCgT6wfJCjs03uxGvQ21UfQscP7gAhUJVKQaoKNI87L/cvoWABVLnbhYO+rd8HELJ3bRaR3OTrz2kfZla76/TjN1up5SLiG3bVX21cfpW10kGtIQG+tmpvHzlaR+RR5dMQWTRHer7hcqaYJKcZ3oXGZX7Su2FIkpAHGKfcrHFqhDkQGY4uw0wOe1zhiPlA8h8Glweh80gkTKx8FqItRxUBcppJGhkR1B5ynVYXds6kMvR96cOgvqsplJ4lJwjIlcZe1sEssDY0TyGuUKYhL1UvUfG+cR5tSFUTdnudJMbani68M8pXJ12Jvkurkm8Zpk3XhIEYuaVeiCjFe1TemCcDNlM2ePTpR4dj4eS2xMaZxIdBPVEvQi4mxTopZOSV0+Bck1D4MoYstvuhbdKNHEvmhLnwQNE8pqVfVb+XLcO5GXjPmUS01JsC56Vb8d983OjeYkCEbKAf/t2LR9aIlHMKXMJMYvmDtSSGgolI+ffwedegtdoGQTUpR8x/j1YDIMNLSeU/5UF7XdLwRTjNBkSRkOp4930zmeQi2eKgDKgPN02u951hWTwKrM3Hmwiumt4TSfFzqbnqveyV6PTburnsrT3tERkwlUWe4YBJ+6vnkR6F+kgCl0oeu56kfDJIG0VFPo/OK5kiQBTS8LHYSfq75pbcK6RPEk5K6Vy0kiWSBUaF6N6qfIBHppAw2DOkBOXwWkpS1aVJkqAqiMNVaeM2UUtNg/MZeQTHOpMgP72PdHP7eJyJCn5/KKDkR1oJSZ0Bku1llXB7YSUAIOY90417va1KnL1q2L0siPyrJZLbhJQpP7RJcTcKSlNKfcTBhRFhudL6fTOE8r+6nywR/qvi73A283L4+dLJWGF5gqZdphPUt36QJ691OiAcpM45xZubGL1s+V8d9IOrgzMIlTugBQn5P7MU1wM0vqDMo6Rd05bIYTCmhaPRG+oMym6655enIBQz1VybjLhCTdFIOZzremXQ+1UOkAyvQOO8dXCZTmC0r0DjvJVQKrT9Xe9X2ab8RTgpboHp0RJzoujXKpbnrcN8+uDEqopDpX2jfPTwaxTqCkm1gAppptNC2HCrV9Qg5JCXFU0lx+CKb7CYb3+Y4WTvOXMvTtm2dvgOlySpmc7Zvn4TuiXV++HF2s0HCsrNa9VO1zxScLmpZNNXndFG3ETds83HUoGeRIF5f87IGW61KtRYMQTrnRYlemtKbe7fbV57Kt2uq57nqGYcrhwXlJO63PpooEKimIl/qlGngNNy+j46KMnt4uBid5n8KJ/TceJ8aJdZ34omIqX04EDWQTcXWGx3mLkTKXO5R9/akKhU4K5Ezn/j67QHesTslrds6OdVLZBEZjHii3MozFBZd8dza26WLnKMffUQSUncWNLoiM0vyISQvrxSrLnqvDsBhj6QjBm5LZ8vMbxwvoClw5rc7l0ObUbt06FBkJ5Qr0WHbd56Z1Z9QNzTCV6YOf1dCtS4jnMqD2uTH8E2HJ6LDZNLsqlyODTH+/I90ii9qn1jAnp9V3nOhrVM6B5MPtdCFMUy44u7ouIh3bZlt1XfVp+NExlKaayrqiRE3STUHJmDpMTHy00U1CxxOzjSZy0URzb3SDa74D7z5AGkmUzIORImAkpvO9ziFmUW7qQIsGqCQujKyub+vDs8yGFLT0qVxVt+Vnb/cTZWsi5ZwgTXrO3r0RulMegWdqYCqSKwv5oyJDG/KqEXVi0IWYUVxo4wWZHZU7jQeBdctWJ2S0I104kDYW5zRnnyq1kE/Uq/LQySQ5dMtEiXLPspwdO4Mxjr4u1JgtC45N9ISGEo+BbQ90Z18yTkfTztdIeRSlPTnsON1IAXjetaSD87TZ2+7Q9XanENFqge1QLuJVwA3NklPdOPibx4E6BEY6eFgxQhVwQx9cqvMLKkxIHGmRHJWu1kmVfFqhLM6by3T46KpeCofUI0C5ccmI8iMB0PMeoNxm1H1sTvtdoPZHF3vKOrufetI91soCYteX/anbMt6zoKsSJTnd9V9cQpbSRMp9fUMVgu2Schb5ukEbcnw3JaeBexNPU+EKaWLJixbjle7Doz0Rcd5uav9V7jo9dZV71MCdA6g7gm4CPXVDRZmfVKCAUK6RPlVt5x2/oj6orLd8LltHSEp9ZTNVCVYIEweT5qma+s3Pjw/H+ljt60P18PrDz3/88f8BWylCxA=="; \ No newline at end of file diff --git a/docs/classes/ApiApp.html b/docs/classes/ApiApp.html index bebd8c51..92e29b5c 100644 --- a/docs/classes/ApiApp.html +++ b/docs/classes/ApiApp.html @@ -46,9 +46,9 @@

Returns void

  • Configure the InversifyJS IOC Container instance.

    Parameters

    • configureBlock: (this: void, container: Container) => void

      Function that takes a Container instance as a parameter.

    Returns void

  • Initialise all controllers and endpoints declared using decorators.

    -

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/ApiLambdaApp.html b/docs/classes/ApiLambdaApp.html index 45477be6..84aa2564 100644 --- a/docs/classes/ApiLambdaApp.html +++ b/docs/classes/ApiLambdaApp.html @@ -2,7 +2,7 @@ AWS Lambda requests and can be used to provide a Lambda function handler.

The run method is the function handler entrypoint.

-

Hierarchy (View Summary)

Index

Constructors

constructor +

Hierarchy (View Summary)

Index

Constructors

constructor

Properties

apiServer appConfig appContainer @@ -14,6 +14,7 @@

Accessors

middlewareRegistry

Methods

configureApi configureApp +createHandler initialiseControllers run

Constructors

  • Create a new lambda app.

    @@ -26,7 +27,7 @@
  • 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.

    -

Returns ApiLambdaApp

Properties

apiServer: Server
appConfig: AppConfig = ...

(Optional) Application config to pass to lambda-api, defaults to new AppConfig.

+

Returns ApiLambdaApp

Properties

apiServer: Server
appConfig: AppConfig = ...

(Optional) Application config to pass to lambda-api, defaults to new AppConfig.

appContainer: 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. If you pass your own @@ -40,9 +41,12 @@

Parameters

  • configureBlock: (this: void, api: API) => void

    Function that takes an API instance as a parameter.

Returns void

  • Configure the InversifyJS IOC Container instance.

    Parameters

    • configureBlock: (this: void, container: Container) => void

      Function that takes a Container instance as a parameter.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/ApiRequest.html b/docs/classes/ApiRequest.html index a38d6e30..974cf62a 100644 --- a/docs/classes/ApiRequest.html +++ b/docs/classes/ApiRequest.html @@ -1,7 +1,7 @@ ApiRequest | ts-lambda-api - v2.5.3
ts-lambda-api - v2.5.3
    Preparing search index...

    Class ApiRequest

    AWS Lambda HTTP request event. Used for testing, enabling manually passing requests to a ApiLambdaApp instance.

    -
    Index

    Constructors

    constructor +
    Index

    Constructors

    constructor

    Properties

    body headers httpMethod @@ -9,9 +9,9 @@ path queryStringParameters

    Constructors

    Properties

    body

    body: string

    HTTP request event body, potentially Base64 encoded.

    -
    headers: object = {}

    HTTP request headers as a map.

    -
    httpMethod: string

    HTTP method ('GET', 'POST', 'PUT' etc.)

    -
    isBase64Encoded: boolean

    Is the body property Base64 encoded?

    -
    path: string

    Request URL path. Excludes protocol, host and port.

    -
    queryStringParameters: object = {}

    HTTP request query string parameters as a map.

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +
    headers: object = {}

    HTTP request headers as a map.

    +
    httpMethod: string

    HTTP method ('GET', 'POST', 'PUT' etc.)

    +
    isBase64Encoded: boolean

    Is the body property Base64 encoded?

    +
    path: string

    Request URL path. Excludes protocol, host and port.

    +
    queryStringParameters: object = {}

    HTTP request query string parameters as a map.

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/docs/classes/Server.html b/docs/classes/Server.html index 5d4cb27b..1843162b 100644 --- a/docs/classes/Server.html +++ b/docs/classes/Server.html @@ -28,9 +28,9 @@ Dynamic loading of injectable controllers is disabled if undefined or the app Container instance has its autobind flag disabled.

    -

    Returns Promise<void>

    • Takes an API request passed in by AWS Lambda and processes +

    Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/_internal_.Agent-1.html b/docs/classes/_internal_.Agent-1.html index f350212b..1d916816 100644 --- a/docs/classes/_internal_.Agent-1.html +++ b/docs/classes/_internal_.Agent-1.html @@ -1,6 +1,6 @@ Agent | ts-lambda-api - v2.5.3
    ts-lambda-api - v2.5.3
      Preparing search index...

      Class Agent

      An Agent object for HTTPS similar to http.Agent. See request for more information.

      v0.4.5

      -

      Hierarchy (View Summary)

      Index

      Constructors

      constructor +

      Hierarchy (View Summary)

      Index

      Constructors

      constructor

      Properties

      freeSockets maxFreeSockets maxSockets diff --git a/docs/classes/_internal_.Agent.html b/docs/classes/_internal_.Agent.html index bac0a352..2ab3cfe7 100644 --- a/docs/classes/_internal_.Agent.html +++ b/docs/classes/_internal_.Agent.html @@ -37,7 +37,7 @@

      v0.3.4

      -

      Hierarchy (View Summary)

      Index

      Constructors

      constructor +

      Hierarchy (View Summary)

      Index

      Constructors

      constructor

      Properties

      freeSockets maxFreeSockets maxSockets diff --git a/docs/classes/_internal_.Alias.html b/docs/classes/_internal_.Alias.html index 6c764b2a..9a3935d6 100644 --- a/docs/classes/_internal_.Alias.html +++ b/docs/classes/_internal_.Alias.html @@ -1,4 +1,4 @@ -Alias | ts-lambda-api - v2.5.3
      ts-lambda-api - v2.5.3
        Preparing search index...

        Class Alias

        Hierarchy (View Summary)

        Index

        Constructors

        constructor +Alias | ts-lambda-api - v2.5.3
        ts-lambda-api - v2.5.3
          Preparing search index...

          Class Alias

          Hierarchy (View Summary)

          Index

          Constructors

          constructor

          Properties

          [NODE_TYPE] addToJSMap? anchor? diff --git a/docs/classes/_internal_.ApiBody.html b/docs/classes/_internal_.ApiBody.html index 3479c41b..f52d2622 100644 --- a/docs/classes/_internal_.ApiBody.html +++ b/docs/classes/_internal_.ApiBody.html @@ -1,5 +1,5 @@ ApiBody | ts-lambda-api - v2.5.3
          ts-lambda-api - v2.5.3
            Preparing search index...

            Class ApiBody

            Describes the body of a HTTP request or response.

            -

            Hierarchy (View Summary)

            Index

            Constructors

            constructor +

            Hierarchy (View Summary)

            Index

            Constructors

            constructor

            Properties

            class? contentType? description? diff --git a/docs/classes/_internal_.ApiBodyInfo.html b/docs/classes/_internal_.ApiBodyInfo.html index 04aac825..dd3ed065 100644 --- a/docs/classes/_internal_.ApiBodyInfo.html +++ b/docs/classes/_internal_.ApiBodyInfo.html @@ -1,5 +1,5 @@ ApiBodyInfo | ts-lambda-api - v2.5.3
            ts-lambda-api - v2.5.3
              Preparing search index...

              Class ApiBodyInfo

              Describes the body of a HTTP request or response.

              -

              Hierarchy (View Summary)

              Index

              Constructors

              constructor +

              Hierarchy (View Summary)

              Index

              Constructors

              constructor

              Properties

              class? contentType? description? diff --git a/docs/classes/_internal_.ApiOperation.html b/docs/classes/_internal_.ApiOperation.html index 0a49ef92..66b309fc 100644 --- a/docs/classes/_internal_.ApiOperation.html +++ b/docs/classes/_internal_.ApiOperation.html @@ -1,5 +1,5 @@ ApiOperation | ts-lambda-api - v2.5.3
              ts-lambda-api - v2.5.3
                Preparing search index...

                Class ApiOperation

                Describes an API endpoint.

                -

                Hierarchy (View Summary)

                Index

                Constructors

                constructor +

                Hierarchy (View Summary)

                Index

                Constructors

                constructor

                Properties

                description? name? request? diff --git a/docs/classes/_internal_.ApiOperationInfo.html b/docs/classes/_internal_.ApiOperationInfo.html index 41c9aa47..09bb314c 100644 --- a/docs/classes/_internal_.ApiOperationInfo.html +++ b/docs/classes/_internal_.ApiOperationInfo.html @@ -1,5 +1,5 @@ ApiOperationInfo | ts-lambda-api - v2.5.3
                ts-lambda-api - v2.5.3
                  Preparing search index...

                  Class ApiOperationInfo

                  Describes an API endpoint.

                  -

                  Hierarchy (View Summary)

                  Index

                  Constructors

                  constructor +

                  Hierarchy (View Summary)

                  Index

                  Constructors

                  constructor

                  Properties

                  description? name? request? diff --git a/docs/classes/_internal_.ApiParam.html b/docs/classes/_internal_.ApiParam.html index f31e3c7a..4c26abaa 100644 --- a/docs/classes/_internal_.ApiParam.html +++ b/docs/classes/_internal_.ApiParam.html @@ -1,5 +1,5 @@ ApiParam | ts-lambda-api - v2.5.3
                  ts-lambda-api - v2.5.3
                    Preparing search index...

                    Class ApiParam

                    Describes a parameter in a HTTP request.

                    -

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor +

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor

                    Properties

                    class? contentType? description? diff --git a/docs/classes/_internal_.AsyncResource.html b/docs/classes/_internal_.AsyncResource.html index 34c37aa9..d0af4e83 100644 --- a/docs/classes/_internal_.AsyncResource.html +++ b/docs/classes/_internal_.AsyncResource.html @@ -6,7 +6,7 @@ 
                    import { AsyncResource, executionAsyncId } from 'node:async_hooks';

                    // AsyncResource() is meant to be extended. Instantiating a
                    // new AsyncResource() also triggers init. If triggerAsyncId is omitted then
                    // async_hook.executionAsyncId() is used.
                    const asyncResource = new AsyncResource(
                      type, { triggerAsyncId: executionAsyncId(), requireManualDestroy: false },
                    );

                    // Run a function in the execution context of the resource. This will
                    // * establish the context of the resource
                    // * trigger the AsyncHooks before callbacks
                    // * call the provided function `fn` with the supplied arguments
                    // * trigger the AsyncHooks after callbacks
                    // * restore the original execution context
                    asyncResource.runInAsyncScope(fn, thisArg, ...args);

                    // Call AsyncHooks destroy callbacks.
                    asyncResource.emitDestroy();

                    // Return the unique ID assigned to the AsyncResource instance.
                    asyncResource.asyncId();

                    // Return the trigger ID for the AsyncResource instance.
                    asyncResource.triggerAsyncId();
                    -

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor +

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor

                    Methods

                    asyncId bind emitDestroy diff --git a/docs/classes/_internal_.ClientRequest.html b/docs/classes/_internal_.ClientRequest.html index b97c5680..d84b0fc7 100644 --- a/docs/classes/_internal_.ClientRequest.html +++ b/docs/classes/_internal_.ClientRequest.html @@ -21,7 +21,7 @@ identified by code:``'ERR_HTTP_CONTENT_LENGTH_MISMATCH'.

                    Content-Length value should be in bytes, not characters. Use Buffer.byteLength() to determine the length of the body in bytes.

                    v0.1.17

                    -

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor +

                    Hierarchy (View Summary)

                    Index

                    Constructors

                    constructor

                    Properties

                    aborted chunkedEncoding closed diff --git a/docs/classes/_internal_.Collection.html b/docs/classes/_internal_.Collection.html index 4daffa23..3c3b3d49 100644 --- a/docs/classes/_internal_.Collection.html +++ b/docs/classes/_internal_.Collection.html @@ -1,4 +1,4 @@ -Collection | ts-lambda-api - v2.5.3
                    ts-lambda-api - v2.5.3
                      Preparing search index...

                      Class CollectionAbstract

                      Hierarchy (View Summary)

                      Index

                      Constructors

                      constructor +Collection | ts-lambda-api - v2.5.3
                      ts-lambda-api - v2.5.3
                        Preparing search index...

                        Class CollectionAbstract

                        Hierarchy (View Summary)

                        Index

                        Constructors

                        constructor

                        Properties

                        [NODE_TYPE] addToJSMap? anchor? diff --git a/docs/classes/_internal_.Document.html b/docs/classes/_internal_.Document.html index add7b033..c29de758 100644 --- a/docs/classes/_internal_.Document.html +++ b/docs/classes/_internal_.Document.html @@ -1,4 +1,4 @@ -Document | ts-lambda-api - v2.5.3
                        ts-lambda-api - v2.5.3
                          Preparing search index...

                          Class Document<Contents, Strict>

                          Type Parameters

                          • Contents extends Node = Node
                          • Strict extends boolean = true

                          Hierarchy (View Summary)

                          Index

                          Constructors

                          constructor +Document | ts-lambda-api - v2.5.3
                          ts-lambda-api - v2.5.3
                            Preparing search index...

                            Class Document<Contents, Strict>

                            Type Parameters

                            • Contents extends Node = Node
                            • Strict extends boolean = true

                            Hierarchy (View Summary)

                            Index

                            Constructors

                            constructor

                            Properties

                            [NODE_TYPE] comment commentBefore diff --git a/docs/classes/_internal_.EventEmitter.EventEmitterAsyncResource.html b/docs/classes/_internal_.EventEmitter.EventEmitterAsyncResource.html index 280f67e7..2278a031 100644 --- a/docs/classes/_internal_.EventEmitter.EventEmitterAsyncResource.html +++ b/docs/classes/_internal_.EventEmitter.EventEmitterAsyncResource.html @@ -7,7 +7,7 @@

                            The EventEmitterAsyncResource class has the same methods and takes the same options as EventEmitter and AsyncResource themselves.

                            v17.4.0, v16.14.0

                            -

                            Hierarchy (View Summary)

                            Index

                            Constructors

                            constructor +

                            Hierarchy (View Summary)

                            Index

                            Constructors

                            constructor

                            Properties

                            asyncId asyncResource triggerAsyncId diff --git a/docs/classes/_internal_.EventEmitter.html b/docs/classes/_internal_.EventEmitter.html index a76c8803..7b8695be 100644 --- a/docs/classes/_internal_.EventEmitter.html +++ b/docs/classes/_internal_.EventEmitter.html @@ -6,7 +6,7 @@ added and 'removeListener' when existing listeners are removed.

                            It supports the following option:

                            v0.1.26

                            -

                            Type Parameters

                            Hierarchy (View Summary)

                            Index

                            Constructors

                            constructor +

                            Type Parameters

                            Hierarchy (View Summary)

                            Index

                            Constructors

                            constructor

                            Properties

                            captureRejections captureRejectionSymbol defaultMaxListeners diff --git a/docs/classes/_internal_.HttpRequest.html b/docs/classes/_internal_.HttpRequest.html index 0d5a194f..0de6e5ac 100644 --- a/docs/classes/_internal_.HttpRequest.html +++ b/docs/classes/_internal_.HttpRequest.html @@ -1,4 +1,4 @@ -HttpRequest | ts-lambda-api - v2.5.3
                            ts-lambda-api - v2.5.3
                              Preparing search index...

                              Class HttpRequest

                              Hierarchy (View Summary)

                              Implements

                              Index

                              Constructors

                              constructor +HttpRequest | ts-lambda-api - v2.5.3
                              ts-lambda-api - v2.5.3
                                Preparing search index...

                                Class HttpRequest

                                Hierarchy (View Summary)

                                Implements

                                Index

                                Constructors

                                constructor

                                Properties

                                body? fragment? headers diff --git a/docs/classes/_internal_.HttpResponse.html b/docs/classes/_internal_.HttpResponse.html index f3e134ef..970da8c7 100644 --- a/docs/classes/_internal_.HttpResponse.html +++ b/docs/classes/_internal_.HttpResponse.html @@ -1,4 +1,4 @@ -HttpResponse | ts-lambda-api - v2.5.3
                                ts-lambda-api - v2.5.3
                                  Preparing search index...

                                  Class HttpResponse

                                  Hierarchy (View Summary)

                                  Index

                                  Constructors

                                  constructor +HttpResponse | ts-lambda-api - v2.5.3
                                  ts-lambda-api - v2.5.3
                                    Preparing search index...

                                    Class HttpResponse

                                    Hierarchy (View Summary)

                                    Index

                                    Constructors

                                    constructor

                                    Properties

                                    body? headers reason? diff --git a/docs/classes/_internal_.IncomingMessage.html b/docs/classes/_internal_.IncomingMessage.html index 4b06029e..e4fb3eb9 100644 --- a/docs/classes/_internal_.IncomingMessage.html +++ b/docs/classes/_internal_.IncomingMessage.html @@ -5,7 +5,7 @@ parse and emit the incoming HTTP headers and payload, as the underlying socket may be reused multiple times in case of keep-alive.

                                    v0.1.17

                                    -

                                    Hierarchy (View Summary)

                                    Index

                                    Constructors

                                    constructor +

                                    Hierarchy (View Summary)

                                    Index

                                    Constructors

                                    constructor

                                    Properties

                                    aborted closed complete diff --git a/docs/classes/_internal_.NodeBase.html b/docs/classes/_internal_.NodeBase.html index de6efdf3..3a3b0cbe 100644 --- a/docs/classes/_internal_.NodeBase.html +++ b/docs/classes/_internal_.NodeBase.html @@ -1,4 +1,4 @@ -NodeBase | ts-lambda-api - v2.5.3
                                    ts-lambda-api - v2.5.3
                                      Preparing search index...

                                      Class NodeBaseAbstract

                                      Hierarchy (View Summary)

                                      Index

                                      Constructors

                                      constructor +NodeBase | ts-lambda-api - v2.5.3
                                      ts-lambda-api - v2.5.3
                                        Preparing search index...

                                        Class NodeBaseAbstract

                                        Hierarchy (View Summary)

                                        Index

                                        Constructors

                                        constructor

                                        Properties

                                        [NODE_TYPE] addToJSMap? comment? diff --git a/docs/classes/_internal_.OutgoingMessage.html b/docs/classes/_internal_.OutgoingMessage.html index 9b494b4d..2f9db515 100644 --- a/docs/classes/_internal_.OutgoingMessage.html +++ b/docs/classes/_internal_.OutgoingMessage.html @@ -1,7 +1,7 @@ OutgoingMessage | ts-lambda-api - v2.5.3
                                        ts-lambda-api - v2.5.3
                                          Preparing search index...

                                          Class OutgoingMessage<Request>

                                          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.

                                          v0.1.17

                                          -

                                          Type Parameters

                                          Hierarchy (View Summary)

                                          Index

                                          Constructors

                                          constructor +

                                          Type Parameters

                                          Hierarchy (View Summary)

                                          Index

                                          Constructors

                                          constructor

                                          Properties

                                          chunkedEncoding closed connection diff --git a/docs/classes/_internal_.Readable.html b/docs/classes/_internal_.Readable.html index bb29f2ac..7345405d 100644 --- a/docs/classes/_internal_.Readable.html +++ b/docs/classes/_internal_.Readable.html @@ -1,5 +1,5 @@ Readable | ts-lambda-api - v2.5.3
                                          ts-lambda-api - v2.5.3
                                            Preparing search index...

                                            Class Readable

                                            v0.9.4

                                            -

                                            Hierarchy (View Summary)

                                            Implements

                                            Index

                                            Constructors

                                            constructor +

                                            Hierarchy (View Summary)

                                            Implements

                                            Index

                                            Constructors

                                            constructor

                                            Properties

                                            closed destroyed errored diff --git a/docs/classes/_internal_.Scalar.html b/docs/classes/_internal_.Scalar.html index ac24e914..34343148 100644 --- a/docs/classes/_internal_.Scalar.html +++ b/docs/classes/_internal_.Scalar.html @@ -1,4 +1,4 @@ -Scalar | ts-lambda-api - v2.5.3
                                            ts-lambda-api - v2.5.3
                                              Preparing search index...

                                              Class Scalar<T>

                                              Type Parameters

                                              • T = unknown

                                              Hierarchy (View Summary)

                                              Index

                                              Constructors

                                              constructor +Scalar | ts-lambda-api - v2.5.3
                                              ts-lambda-api - v2.5.3
                                                Preparing search index...

                                                Class Scalar<T>

                                                Type Parameters

                                                • T = unknown

                                                Hierarchy (View Summary)

                                                Index

                                                Constructors

                                                constructor

                                                Properties

                                                [NODE_TYPE] addToJSMap? anchor? diff --git a/docs/classes/_internal_.Socket.html b/docs/classes/_internal_.Socket.html index 3a9101cb..f760624f 100644 --- a/docs/classes/_internal_.Socket.html +++ b/docs/classes/_internal_.Socket.html @@ -8,7 +8,7 @@ is received. For example, it is passed to the listeners of a 'connection' event emitted on a Server, so the user can use it to interact with the client.

                                                v0.3.4

                                                -

                                                Hierarchy (View Summary)

                                                Index

                                                Constructors

                                                constructor +

                                                Hierarchy (View Summary)

                                                Index

                                                Constructors

                                                constructor

                                                Properties

                                                allowHalfOpen autoSelectFamilyAttemptedAddresses bufferSize diff --git a/docs/classes/_internal_.Stream.Duplex.html b/docs/classes/_internal_.Stream.Duplex.html index a3f444d5..11a90f20 100644 --- a/docs/classes/_internal_.Stream.Duplex.html +++ b/docs/classes/_internal_.Stream.Duplex.html @@ -6,7 +6,7 @@
                                              • crypto streams

                                                • v0.9.4

                                                -

                                                Hierarchy (View Summary)

                                                Implements

                                                Index

                                                Constructors

                                                constructor +

                                                Hierarchy (View Summary)

                                                Implements

                                                Index

                                                Constructors

                                                constructor

                                                Properties

                                                allowHalfOpen closed destroyed diff --git a/docs/classes/_internal_.Stream.PassThrough.html b/docs/classes/_internal_.Stream.PassThrough.html index 8884405a..50ab2860 100644 --- a/docs/classes/_internal_.Stream.PassThrough.html +++ b/docs/classes/_internal_.Stream.PassThrough.html @@ -1,6 +1,6 @@ PassThrough | ts-lambda-api - v2.5.3
                                                ts-lambda-api - v2.5.3
                                                  Preparing search index...

                                                  Class PassThrough

                                                  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.

                                                  -

                                                  Hierarchy (View Summary)

                                                  Index

                                                  Constructors

                                                  constructor +

                                                  Hierarchy (View Summary)

                                                  Index

                                                  Constructors

                                                  constructor

                                                  Properties

                                                  allowHalfOpen closed destroyed diff --git a/docs/classes/_internal_.Stream.Transform.html b/docs/classes/_internal_.Stream.Transform.html index 346ae8d9..4c81eb13 100644 --- a/docs/classes/_internal_.Stream.Transform.html +++ b/docs/classes/_internal_.Stream.Transform.html @@ -7,7 +7,7 @@
                                                • crypto streams

                                                  • v0.9.4

                                                  -

                                                  Hierarchy (View Summary)

                                                  Index

                                                  Constructors

                                                  constructor +

                                                  Hierarchy (View Summary)

                                                  Index

                                                  Constructors

                                                  constructor

                                                  Properties

                                                  allowHalfOpen closed destroyed diff --git a/docs/classes/_internal_.Stream.Writable.html b/docs/classes/_internal_.Stream.Writable.html index e97f1166..07f7e2b3 100644 --- a/docs/classes/_internal_.Stream.Writable.html +++ b/docs/classes/_internal_.Stream.Writable.html @@ -1,5 +1,5 @@ Writable | ts-lambda-api - v2.5.3
                                                  ts-lambda-api - v2.5.3
                                                    Preparing search index...

                                                    Class Writable

                                                    v0.9.4

                                                    -

                                                    Hierarchy (View Summary)

                                                    Implements

                                                    Index

                                                    Constructors

                                                    constructor +

                                                    Hierarchy (View Summary)

                                                    Implements

                                                    Index

                                                    Constructors

                                                    constructor

                                                    Properties

                                                    closed destroyed errored diff --git a/docs/classes/_internal_.Stream.html b/docs/classes/_internal_.Stream.html index 21ef1130..4241a3e6 100644 --- a/docs/classes/_internal_.Stream.html +++ b/docs/classes/_internal_.Stream.html @@ -6,7 +6,7 @@ added and 'removeListener' when existing listeners are removed.

                                                    It supports the following option:

                                                    v0.1.26

                                                    -

                                                    Hierarchy (View Summary)

                                                    Index

                                                    Constructors

                                                    constructor +

                                                    Hierarchy (View Summary)

                                                    Index

                                                    Constructors

                                                    constructor

                                                    Properties

                                                    captureRejections captureRejectionSymbol defaultMaxListeners diff --git a/docs/classes/_internal_.URL.html b/docs/classes/_internal_.URL.html index db594f37..3819f57b 100644 --- a/docs/classes/_internal_.URL.html +++ b/docs/classes/_internal_.URL.html @@ -7,7 +7,7 @@ using the delete keyword on any properties of URL objects (e.g. delete myURL.protocol, delete myURL.pathname, etc) has no effect but will still return true.

                                                    v7.0.0, v6.13.0

                                                    -

                                                    Hierarchy (View Summary)

                                                    Index

                                                    Constructors

                                                    constructor +

                                                    Hierarchy (View Summary)

                                                    Index

                                                    Constructors

                                                    constructor

                                                    Properties

                                                    hash host hostname diff --git a/docs/classes/_internal_.YAMLError.html b/docs/classes/_internal_.YAMLError.html index cf15ff7b..565add50 100644 --- a/docs/classes/_internal_.YAMLError.html +++ b/docs/classes/_internal_.YAMLError.html @@ -1,4 +1,4 @@ -YAMLError | ts-lambda-api - v2.5.3
                                                    ts-lambda-api - v2.5.3
                                                      Preparing search index...

                                                      Class YAMLError

                                                      Hierarchy (View Summary)

                                                      Index

                                                      Constructors

                                                      constructor +YAMLError | ts-lambda-api - v2.5.3
                                                      ts-lambda-api - v2.5.3
                                                        Preparing search index...

                                                        Class YAMLError

                                                        Hierarchy (View Summary)

                                                        Index

                                                        Constructors

                                                        constructor

                                                        Properties

                                                        cause? code linePos? diff --git a/docs/classes/_internal_.YAMLMap.html b/docs/classes/_internal_.YAMLMap.html index 3a996f6d..1fe6f2d6 100644 --- a/docs/classes/_internal_.YAMLMap.html +++ b/docs/classes/_internal_.YAMLMap.html @@ -1,4 +1,4 @@ -YAMLMap | ts-lambda-api - v2.5.3
                                                        ts-lambda-api - v2.5.3
                                                          Preparing search index...

                                                          Class YAMLMap<K, V>

                                                          Type Parameters

                                                          • K = unknown
                                                          • V = unknown

                                                          Hierarchy (View Summary)

                                                          Index

                                                          Constructors

                                                          constructor +YAMLMap | ts-lambda-api - v2.5.3
                                                          ts-lambda-api - v2.5.3
                                                            Preparing search index...

                                                            Class YAMLMap<K, V>

                                                            Type Parameters

                                                            • K = unknown
                                                            • V = unknown

                                                            Hierarchy (View Summary)

                                                            Index

                                                            Constructors

                                                            constructor

                                                            Properties

                                                            [NODE_TYPE] addToJSMap? anchor? diff --git a/docs/classes/_internal_.YAMLSeq.html b/docs/classes/_internal_.YAMLSeq.html index 0d04701d..578a0b37 100644 --- a/docs/classes/_internal_.YAMLSeq.html +++ b/docs/classes/_internal_.YAMLSeq.html @@ -1,4 +1,4 @@ -YAMLSeq | ts-lambda-api - v2.5.3
                                                            ts-lambda-api - v2.5.3
                                                              Preparing search index...

                                                              Class YAMLSeq<T>

                                                              Type Parameters

                                                              • T = unknown

                                                              Hierarchy (View Summary)

                                                              Index

                                                              Constructors

                                                              constructor +YAMLSeq | ts-lambda-api - v2.5.3
                                                              ts-lambda-api - v2.5.3
                                                                Preparing search index...

                                                                Class YAMLSeq<T>

                                                                Type Parameters

                                                                • T = unknown

                                                                Hierarchy (View Summary)

                                                                Index

                                                                Constructors

                                                                constructor

                                                                Properties

                                                                [NODE_TYPE] addToJSMap? anchor? diff --git a/docs/classes/_internal_.YAMLWarning.html b/docs/classes/_internal_.YAMLWarning.html index 5c52e166..76e920c0 100644 --- a/docs/classes/_internal_.YAMLWarning.html +++ b/docs/classes/_internal_.YAMLWarning.html @@ -1,4 +1,4 @@ -YAMLWarning | ts-lambda-api - v2.5.3
                                                                ts-lambda-api - v2.5.3
                                                                  Preparing search index...

                                                                  Class YAMLWarning

                                                                  Hierarchy (View Summary)

                                                                  Index

                                                                  Constructors

                                                                  constructor +YAMLWarning | ts-lambda-api - v2.5.3
                                                                  ts-lambda-api - v2.5.3
                                                                    Preparing search index...

                                                                    Class YAMLWarning

                                                                    Hierarchy (View Summary)

                                                                    Index

                                                                    Constructors

                                                                    constructor

                                                                    Properties

                                                                    cause? code linePos? diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 4693a443..ca25d6f2 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -ts-lambda-api - v2.5.3
                                                                    ts-lambda-api - v2.5.3
                                                                      Preparing search index...

                                                                      ts-lambda-api - v2.5.3

                                                                      Hierarchy Summary

                                                                      Settings

                                                                      Member Visibility
                                                                      +ts-lambda-api - v2.5.3
                                                                      ts-lambda-api - v2.5.3
                                                                        Preparing search index...

                                                                        ts-lambda-api - v2.5.3

                                                                        Hierarchy Summary

                                                                        Settings

                                                                        Member Visibility
                                                                        diff --git a/docs/index.html b/docs/index.html index c8467593..7c33da30 100644 --- a/docs/index.html +++ b/docs/index.html @@ -21,6 +21,7 @@

                                                                        ts-lambda-apiDeploy to AWS Lambda @@ -32,6 +33,7 @@

                                                                        ts-lambda-apiDeploy to AWS Lambda
                                                                      • Routing @@ -131,7 +133,7 @@

                                                                        • Settings

                                                                        Member Visibility

                                                                        On This Page

                                                                        ts-lambda-api
                                                                        +

                                                                        Settings

                                                                        Member Visibility

                                                                        On This Page

                                                                        ts-lambda-api
                                                                        diff --git a/docs/interfaces/_internal_.ALBEvent.html b/docs/interfaces/_internal_.ALBEvent.html new file mode 100644 index 00000000..20180135 --- /dev/null +++ b/docs/interfaces/_internal_.ALBEvent.html @@ -0,0 +1,10 @@ +ALBEvent | ts-lambda-api - v2.5.3
                                                                        ts-lambda-api - v2.5.3
                                                                          Preparing search index...

                                                                          Interface ALBEvent

                                                                          interface ALBEvent {
                                                                              body: string;
                                                                              headers?: ALBEventHeaders;
                                                                              httpMethod: string;
                                                                              isBase64Encoded: boolean;
                                                                              multiValueHeaders?: ALBEventMultiValueHeaders;
                                                                              multiValueQueryStringParameters?: ALBEventMultiValueQueryStringParameters;
                                                                              path: string;
                                                                              queryStringParameters?: ALBEventQueryStringParameters;
                                                                              requestContext: ALBEventRequestContext;
                                                                          }
                                                                          Index

                                                                          Properties

                                                                          body +headers? +httpMethod +isBase64Encoded +multiValueHeaders? +multiValueQueryStringParameters? +path +queryStringParameters? +requestContext +

                                                                          Properties

                                                                          body

                                                                          body: string
                                                                          headers?: ALBEventHeaders
                                                                          httpMethod: string
                                                                          isBase64Encoded: boolean
                                                                          multiValueHeaders?: ALBEventMultiValueHeaders
                                                                          multiValueQueryStringParameters?: ALBEventMultiValueQueryStringParameters
                                                                          path: string
                                                                          queryStringParameters?: ALBEventQueryStringParameters
                                                                          requestContext: ALBEventRequestContext

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Properties
                                                                          diff --git a/docs/interfaces/_internal_.ALBEventHeaders.html b/docs/interfaces/_internal_.ALBEventHeaders.html new file mode 100644 index 00000000..1e1964a3 --- /dev/null +++ b/docs/interfaces/_internal_.ALBEventHeaders.html @@ -0,0 +1 @@ +ALBEventHeaders | ts-lambda-api - v2.5.3
                                                                          ts-lambda-api - v2.5.3
                                                                            Preparing search index...

                                                                            Interface ALBEventHeaders

                                                                            Indexable

                                                                            • [name: string]: string

                                                                            Settings

                                                                            Member Visibility
                                                                            diff --git a/docs/interfaces/_internal_.ALBEventMultiValueHeaders.html b/docs/interfaces/_internal_.ALBEventMultiValueHeaders.html new file mode 100644 index 00000000..b8f2e26b --- /dev/null +++ b/docs/interfaces/_internal_.ALBEventMultiValueHeaders.html @@ -0,0 +1 @@ +ALBEventMultiValueHeaders | ts-lambda-api - v2.5.3
                                                                            ts-lambda-api - v2.5.3
                                                                              Preparing search index...

                                                                              Interface ALBEventMultiValueHeaders

                                                                              Indexable

                                                                              • [name: string]: string[]

                                                                              Settings

                                                                              Member Visibility
                                                                              diff --git a/docs/interfaces/_internal_.ALBEventMultiValueQueryStringParameters.html b/docs/interfaces/_internal_.ALBEventMultiValueQueryStringParameters.html new file mode 100644 index 00000000..428c9ac8 --- /dev/null +++ b/docs/interfaces/_internal_.ALBEventMultiValueQueryStringParameters.html @@ -0,0 +1 @@ +ALBEventMultiValueQueryStringParameters | ts-lambda-api - v2.5.3
                                                                              ts-lambda-api - v2.5.3
                                                                                Preparing search index...

                                                                                Interface ALBEventMultiValueQueryStringParameters

                                                                                Indexable

                                                                                • [name: string]: string[]

                                                                                Settings

                                                                                Member Visibility
                                                                                diff --git a/docs/interfaces/_internal_.ALBEventQueryStringParameters.html b/docs/interfaces/_internal_.ALBEventQueryStringParameters.html new file mode 100644 index 00000000..2d4aaa7c --- /dev/null +++ b/docs/interfaces/_internal_.ALBEventQueryStringParameters.html @@ -0,0 +1 @@ +ALBEventQueryStringParameters | ts-lambda-api - v2.5.3
                                                                                ts-lambda-api - v2.5.3
                                                                                  Preparing search index...

                                                                                  Interface ALBEventQueryStringParameters

                                                                                  Indexable

                                                                                  • [name: string]: string

                                                                                  Settings

                                                                                  Member Visibility
                                                                                  diff --git a/docs/interfaces/_internal_.ALBEventRequestContext.html b/docs/interfaces/_internal_.ALBEventRequestContext.html new file mode 100644 index 00000000..7a4b2250 --- /dev/null +++ b/docs/interfaces/_internal_.ALBEventRequestContext.html @@ -0,0 +1,2 @@ +ALBEventRequestContext | ts-lambda-api - v2.5.3
                                                                                  ts-lambda-api - v2.5.3
                                                                                    Preparing search index...

                                                                                    Interface ALBEventRequestContext

                                                                                    interface ALBEventRequestContext {
                                                                                        elb: { targetGroupArn: string };
                                                                                    }
                                                                                    Index

                                                                                    Properties

                                                                                    elb +

                                                                                    Properties

                                                                                    elb: { targetGroupArn: string }

                                                                                    Settings

                                                                                    Member Visibility

                                                                                    On This Page

                                                                                    Properties
                                                                                    diff --git a/docs/interfaces/_internal_.AbortSignal-2.html b/docs/interfaces/_internal_.AbortSignal-2.html index d91bab3f..37952e2b 100644 --- a/docs/interfaces/_internal_.AbortSignal-2.html +++ b/docs/interfaces/_internal_.AbortSignal-2.html @@ -1,4 +1,4 @@ -AbortSignal | ts-lambda-api - v2.5.3
                                                                                    ts-lambda-api - v2.5.3
                                                                                      Preparing search index...

                                                                                      Interface AbortSignal

                                                                                      interface AbortSignal {
                                                                                          aborted: boolean;
                                                                                          onabort: (this: AbortSignal, ev: Event) => any;
                                                                                          reason: any;
                                                                                          addEventListener(
                                                                                              type: string,
                                                                                              listener: EventListener | EventListenerObject,
                                                                                              options?: boolean | AddEventListenerOptions,
                                                                                          ): void;
                                                                                          dispatchEvent(event: Event): boolean;
                                                                                          removeEventListener(
                                                                                              type: string,
                                                                                              listener: EventListener | EventListenerObject,
                                                                                              options?: boolean | EventListenerOptions,
                                                                                          ): void;
                                                                                          throwIfAborted(): void;
                                                                                      }

                                                                                      Hierarchy (View Summary)

                                                                                      Index

                                                                                      Properties

                                                                                      aborted +AbortSignal | ts-lambda-api - v2.5.3
                                                                                      ts-lambda-api - v2.5.3
                                                                                        Preparing search index...

                                                                                        Interface AbortSignal

                                                                                        interface AbortSignal {
                                                                                            aborted: boolean;
                                                                                            onabort: (this: AbortSignal, ev: Event) => any;
                                                                                            reason: any;
                                                                                            addEventListener(
                                                                                                type: string,
                                                                                                listener: EventListener | EventListenerObject,
                                                                                                options?: boolean | AddEventListenerOptions,
                                                                                            ): void;
                                                                                            dispatchEvent(event: Event): boolean;
                                                                                            removeEventListener(
                                                                                                type: string,
                                                                                                listener: EventListener | EventListenerObject,
                                                                                                options?: boolean | EventListenerOptions,
                                                                                            ): void;
                                                                                            throwIfAborted(): void;
                                                                                        }

                                                                                        Hierarchy (View Summary)

                                                                                        Index

                                                                                        Properties

                                                                                        aborted onabort reason

                                                                                        Methods

                                                                                        addEventListener diff --git a/docs/interfaces/_internal_.AbortSignal.html b/docs/interfaces/_internal_.AbortSignal.html index 30c0eb99..37231604 100644 --- a/docs/interfaces/_internal_.AbortSignal.html +++ b/docs/interfaces/_internal_.AbortSignal.html @@ -1,4 +1,4 @@ -AbortSignal | ts-lambda-api - v2.5.3
                                                                                        ts-lambda-api - v2.5.3
                                                                                          Preparing search index...

                                                                                          Interface AbortSignal

                                                                                          interface AbortSignal {
                                                                                              aborted: boolean;
                                                                                              onabort: (this: AbortSignal, ev: Event) => any;
                                                                                              reason: any;
                                                                                              addEventListener(
                                                                                                  type: string,
                                                                                                  listener: EventListener | EventListenerObject,
                                                                                                  options?: boolean | AddEventListenerOptions,
                                                                                              ): void;
                                                                                              dispatchEvent(event: Event): boolean;
                                                                                              removeEventListener(
                                                                                                  type: string,
                                                                                                  listener: EventListener | EventListenerObject,
                                                                                                  options?: boolean | EventListenerOptions,
                                                                                              ): void;
                                                                                              throwIfAborted(): void;
                                                                                          }

                                                                                          Hierarchy (View Summary)

                                                                                          Index

                                                                                          Properties

                                                                                          aborted +AbortSignal | ts-lambda-api - v2.5.3
                                                                                          ts-lambda-api - v2.5.3
                                                                                            Preparing search index...

                                                                                            Interface AbortSignal

                                                                                            interface AbortSignal {
                                                                                                aborted: boolean;
                                                                                                onabort: (this: AbortSignal, ev: Event) => any;
                                                                                                reason: any;
                                                                                                addEventListener(
                                                                                                    type: string,
                                                                                                    listener: EventListener | EventListenerObject,
                                                                                                    options?: boolean | AddEventListenerOptions,
                                                                                                ): void;
                                                                                                dispatchEvent(event: Event): boolean;
                                                                                                removeEventListener(
                                                                                                    type: string,
                                                                                                    listener: EventListener | EventListenerObject,
                                                                                                    options?: boolean | EventListenerOptions,
                                                                                                ): void;
                                                                                                throwIfAborted(): void;
                                                                                            }

                                                                                            Hierarchy (View Summary)

                                                                                            Index

                                                                                            Properties

                                                                                            aborted onabort reason

                                                                                            Methods

                                                                                            addEventListener diff --git a/docs/interfaces/_internal_.AddEventListenerOptions.html b/docs/interfaces/_internal_.AddEventListenerOptions.html index de0e18dc..c5eb8fea 100644 --- a/docs/interfaces/_internal_.AddEventListenerOptions.html +++ b/docs/interfaces/_internal_.AddEventListenerOptions.html @@ -1,4 +1,4 @@ -AddEventListenerOptions | ts-lambda-api - v2.5.3
                                                                                            ts-lambda-api - v2.5.3
                                                                                              Preparing search index...

                                                                                              Interface AddEventListenerOptions

                                                                                              interface AddEventListenerOptions {
                                                                                                  capture?: boolean;
                                                                                                  once?: boolean;
                                                                                                  passive?: boolean;
                                                                                                  signal?: AbortSignal;
                                                                                              }

                                                                                              Hierarchy (View Summary)

                                                                                              Index

                                                                                              Properties

                                                                                              capture? +AddEventListenerOptions | ts-lambda-api - v2.5.3
                                                                                              ts-lambda-api - v2.5.3
                                                                                                Preparing search index...

                                                                                                Interface AddEventListenerOptions

                                                                                                interface AddEventListenerOptions {
                                                                                                    capture?: boolean;
                                                                                                    once?: boolean;
                                                                                                    passive?: boolean;
                                                                                                    signal?: AbortSignal;
                                                                                                }

                                                                                                Hierarchy (View Summary)

                                                                                                Index

                                                                                                Properties

                                                                                                capture? once? passive? signal? diff --git a/docs/interfaces/_internal_.AddOperation.html b/docs/interfaces/_internal_.AddOperation.html index 09e4fa92..b5cab872 100644 --- a/docs/interfaces/_internal_.AddOperation.html +++ b/docs/interfaces/_internal_.AddOperation.html @@ -1,4 +1,4 @@ -AddOperation | ts-lambda-api - v2.5.3
                                                                                                ts-lambda-api - v2.5.3
                                                                                                  Preparing search index...

                                                                                                  Interface AddOperation<T>

                                                                                                  interface AddOperation<T> {
                                                                                                      op: "add";
                                                                                                      path: string;
                                                                                                      value: T;
                                                                                                  }

                                                                                                  Type Parameters

                                                                                                  • T

                                                                                                  Hierarchy (View Summary)

                                                                                                  Index

                                                                                                  Properties

                                                                                                  op +AddOperation | ts-lambda-api - v2.5.3
                                                                                                  ts-lambda-api - v2.5.3
                                                                                                    Preparing search index...

                                                                                                    Interface AddOperation<T>

                                                                                                    interface AddOperation<T> {
                                                                                                        op: "add";
                                                                                                        path: string;
                                                                                                        value: T;
                                                                                                    }

                                                                                                    Type Parameters

                                                                                                    • T

                                                                                                    Hierarchy (View Summary)

                                                                                                    Index

                                                                                                    Properties

                                                                                                    op path value

                                                                                                    Properties

                                                                                                    op: "add"
                                                                                                    path: string
                                                                                                    value: T

                                                                                                    Settings

                                                                                                    Member Visibility

                                                                                                    On This Page

                                                                                                    Properties
                                                                                                    diff --git a/docs/interfaces/_internal_.AgentOptions-1.html b/docs/interfaces/_internal_.AgentOptions-1.html index 19bbd7b2..d7b786e6 100644 --- a/docs/interfaces/_internal_.AgentOptions-1.html +++ b/docs/interfaces/_internal_.AgentOptions-1.html @@ -1,4 +1,4 @@ -AgentOptions | ts-lambda-api - v2.5.3
                                                                                                    ts-lambda-api - v2.5.3
                                                                                                      Preparing search index...

                                                                                                      Interface AgentOptions

                                                                                                      interface AgentOptions {
                                                                                                          agentKeepAliveTimeoutBuffer?: number;
                                                                                                          allowPartialTrustChain?: boolean;
                                                                                                          ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                          ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>;
                                                                                                          autoSelectFamily?: boolean;
                                                                                                          autoSelectFamilyAttemptTimeout?: number;
                                                                                                          blockList?: BlockList;
                                                                                                          ca?:
                                                                                                              | string
                                                                                                              | Buffer<ArrayBufferLike>
                                                                                                              | (string | Buffer<ArrayBufferLike>)[];
                                                                                                          cert?:
                                                                                                              | string
                                                                                                              | Buffer<ArrayBufferLike>
                                                                                                              | (string | Buffer<ArrayBufferLike>)[];
                                                                                                          checkServerIdentity?: (hostname: string, cert: PeerCertificate) => Error;
                                                                                                          ciphers?: string;
                                                                                                          clientCertEngine?: string;
                                                                                                          crl?:
                                                                                                              | string
                                                                                                              | Buffer<ArrayBufferLike>
                                                                                                              | (string | Buffer<ArrayBufferLike>)[];
                                                                                                          defaultPort?: number;
                                                                                                          dhparam?: string | Buffer<ArrayBufferLike>;
                                                                                                          ecdhCurve?: string;
                                                                                                          enableTrace?: boolean;
                                                                                                          family?: number;
                                                                                                          hints?: number;
                                                                                                          honorCipherOrder?: boolean;
                                                                                                          host?: string;
                                                                                                          keepAlive?: boolean;
                                                                                                          keepAliveInitialDelay?: number;
                                                                                                          keepAliveMsecs?: number;
                                                                                                          key?:
                                                                                                              | string
                                                                                                              | Buffer<ArrayBufferLike>
                                                                                                              | (string | Buffer<ArrayBufferLike> | KeyObject)[];
                                                                                                          localAddress?: string;
                                                                                                          localPort?: number;
                                                                                                          lookup?: LookupFunction;
                                                                                                          maxCachedSessions?: number;
                                                                                                          maxFreeSockets?: number;
                                                                                                          maxSockets?: number;
                                                                                                          maxTotalSockets?: number;
                                                                                                          maxVersion?: SecureVersion;
                                                                                                          minDHSize?: number;
                                                                                                          minVersion?: SecureVersion;
                                                                                                          noDelay?: boolean;
                                                                                                          passphrase?: string;
                                                                                                          path?: string;
                                                                                                          pfx?:
                                                                                                              | string
                                                                                                              | Buffer<ArrayBufferLike>
                                                                                                              | (string | Buffer<ArrayBufferLike> | PxfObject)[];
                                                                                                          port?: number;
                                                                                                          privateKeyEngine?: string;
                                                                                                          privateKeyIdentifier?: string;
                                                                                                          protocol?: string;
                                                                                                          proxyEnv?: ProxyEnv;
                                                                                                          pskCallback?: (hint: string) => PSKCallbackNegotation;
                                                                                                          rejectUnauthorized?: boolean;
                                                                                                          requestCert?: boolean;
                                                                                                          scheduling?: "fifo" | "lifo";
                                                                                                          secureContext?: SecureContext;
                                                                                                          secureOptions?: number;
                                                                                                          secureProtocol?: string;
                                                                                                          servername?: string;
                                                                                                          session?: Buffer<ArrayBufferLike>;
                                                                                                          sessionIdContext?: string;
                                                                                                          sessionTimeout?: number;
                                                                                                          sigalgs?: string;
                                                                                                          SNICallback?: (
                                                                                                              servername: string,
                                                                                                              cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                          ) => void;
                                                                                                          socket?: Duplex;
                                                                                                          ticketKeys?: Buffer<ArrayBufferLike>;
                                                                                                          timeout?: number;
                                                                                                      }

                                                                                                      Hierarchy (View Summary)

                                                                                                      Index

                                                                                                      Properties

                                                                                                      agentKeepAliveTimeoutBuffer? +AgentOptions | ts-lambda-api - v2.5.3
                                                                                                      ts-lambda-api - v2.5.3
                                                                                                        Preparing search index...

                                                                                                        Interface AgentOptions

                                                                                                        interface AgentOptions {
                                                                                                            agentKeepAliveTimeoutBuffer?: number;
                                                                                                            allowPartialTrustChain?: boolean;
                                                                                                            ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                            ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>;
                                                                                                            autoSelectFamily?: boolean;
                                                                                                            autoSelectFamilyAttemptTimeout?: number;
                                                                                                            blockList?: BlockList;
                                                                                                            ca?:
                                                                                                                | string
                                                                                                                | Buffer<ArrayBufferLike>
                                                                                                                | (string | Buffer<ArrayBufferLike>)[];
                                                                                                            cert?:
                                                                                                                | string
                                                                                                                | Buffer<ArrayBufferLike>
                                                                                                                | (string | Buffer<ArrayBufferLike>)[];
                                                                                                            checkServerIdentity?: (hostname: string, cert: PeerCertificate) => Error;
                                                                                                            ciphers?: string;
                                                                                                            clientCertEngine?: string;
                                                                                                            crl?:
                                                                                                                | string
                                                                                                                | Buffer<ArrayBufferLike>
                                                                                                                | (string | Buffer<ArrayBufferLike>)[];
                                                                                                            defaultPort?: number;
                                                                                                            dhparam?: string | Buffer<ArrayBufferLike>;
                                                                                                            ecdhCurve?: string;
                                                                                                            enableTrace?: boolean;
                                                                                                            family?: number;
                                                                                                            hints?: number;
                                                                                                            honorCipherOrder?: boolean;
                                                                                                            host?: string;
                                                                                                            keepAlive?: boolean;
                                                                                                            keepAliveInitialDelay?: number;
                                                                                                            keepAliveMsecs?: number;
                                                                                                            key?:
                                                                                                                | string
                                                                                                                | Buffer<ArrayBufferLike>
                                                                                                                | (string | Buffer<ArrayBufferLike> | KeyObject)[];
                                                                                                            localAddress?: string;
                                                                                                            localPort?: number;
                                                                                                            lookup?: LookupFunction;
                                                                                                            maxCachedSessions?: number;
                                                                                                            maxFreeSockets?: number;
                                                                                                            maxSockets?: number;
                                                                                                            maxTotalSockets?: number;
                                                                                                            maxVersion?: SecureVersion;
                                                                                                            minDHSize?: number;
                                                                                                            minVersion?: SecureVersion;
                                                                                                            noDelay?: boolean;
                                                                                                            passphrase?: string;
                                                                                                            path?: string;
                                                                                                            pfx?:
                                                                                                                | string
                                                                                                                | Buffer<ArrayBufferLike>
                                                                                                                | (string | Buffer<ArrayBufferLike> | PxfObject)[];
                                                                                                            port?: number;
                                                                                                            privateKeyEngine?: string;
                                                                                                            privateKeyIdentifier?: string;
                                                                                                            protocol?: string;
                                                                                                            proxyEnv?: ProxyEnv;
                                                                                                            pskCallback?: (hint: string) => PSKCallbackNegotation;
                                                                                                            rejectUnauthorized?: boolean;
                                                                                                            requestCert?: boolean;
                                                                                                            scheduling?: "fifo" | "lifo";
                                                                                                            secureContext?: SecureContext;
                                                                                                            secureOptions?: number;
                                                                                                            secureProtocol?: string;
                                                                                                            servername?: string;
                                                                                                            session?: Buffer<ArrayBufferLike>;
                                                                                                            sessionIdContext?: string;
                                                                                                            sessionTimeout?: number;
                                                                                                            sigalgs?: string;
                                                                                                            SNICallback?: (
                                                                                                                servername: string,
                                                                                                                cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                            ) => void;
                                                                                                            socket?: Duplex;
                                                                                                            ticketKeys?: Buffer<ArrayBufferLike>;
                                                                                                            timeout?: number;
                                                                                                        }

                                                                                                        Hierarchy (View Summary)

                                                                                                        Index

                                                                                                        Properties

                                                                                                        agentKeepAliveTimeoutBuffer? allowPartialTrustChain? ALPNCallback? ALPNProtocols? diff --git a/docs/interfaces/_internal_.AgentOptions.html b/docs/interfaces/_internal_.AgentOptions.html index fc59ebc9..f1c88e31 100644 --- a/docs/interfaces/_internal_.AgentOptions.html +++ b/docs/interfaces/_internal_.AgentOptions.html @@ -1,4 +1,4 @@ -AgentOptions | ts-lambda-api - v2.5.3
                                                                                                        ts-lambda-api - v2.5.3
                                                                                                          Preparing search index...

                                                                                                          Interface AgentOptions

                                                                                                          interface AgentOptions {
                                                                                                              agentKeepAliveTimeoutBuffer?: number;
                                                                                                              autoSelectFamily?: boolean;
                                                                                                              autoSelectFamilyAttemptTimeout?: number;
                                                                                                              blockList?: BlockList;
                                                                                                              defaultPort?: number;
                                                                                                              family?: number;
                                                                                                              hints?: number;
                                                                                                              host?: string;
                                                                                                              keepAlive?: boolean;
                                                                                                              keepAliveInitialDelay?: number;
                                                                                                              keepAliveMsecs?: number;
                                                                                                              localAddress?: string;
                                                                                                              localPort?: number;
                                                                                                              lookup?: LookupFunction;
                                                                                                              maxFreeSockets?: number;
                                                                                                              maxSockets?: number;
                                                                                                              maxTotalSockets?: number;
                                                                                                              noDelay?: boolean;
                                                                                                              port?: number;
                                                                                                              protocol?: string;
                                                                                                              proxyEnv?: ProxyEnv;
                                                                                                              scheduling?: "fifo" | "lifo";
                                                                                                              timeout?: number;
                                                                                                          }

                                                                                                          Hierarchy (View Summary)

                                                                                                          Index

                                                                                                          Properties

                                                                                                          agentKeepAliveTimeoutBuffer? +AgentOptions | ts-lambda-api - v2.5.3
                                                                                                          ts-lambda-api - v2.5.3
                                                                                                            Preparing search index...

                                                                                                            Interface AgentOptions

                                                                                                            interface AgentOptions {
                                                                                                                agentKeepAliveTimeoutBuffer?: number;
                                                                                                                autoSelectFamily?: boolean;
                                                                                                                autoSelectFamilyAttemptTimeout?: number;
                                                                                                                blockList?: BlockList;
                                                                                                                defaultPort?: number;
                                                                                                                family?: number;
                                                                                                                hints?: number;
                                                                                                                host?: string;
                                                                                                                keepAlive?: boolean;
                                                                                                                keepAliveInitialDelay?: number;
                                                                                                                keepAliveMsecs?: number;
                                                                                                                localAddress?: string;
                                                                                                                localPort?: number;
                                                                                                                lookup?: LookupFunction;
                                                                                                                maxFreeSockets?: number;
                                                                                                                maxSockets?: number;
                                                                                                                maxTotalSockets?: number;
                                                                                                                noDelay?: boolean;
                                                                                                                port?: number;
                                                                                                                protocol?: string;
                                                                                                                proxyEnv?: ProxyEnv;
                                                                                                                scheduling?: "fifo" | "lifo";
                                                                                                                timeout?: number;
                                                                                                            }

                                                                                                            Hierarchy (View Summary)

                                                                                                            Index

                                                                                                            Properties

                                                                                                            agentKeepAliveTimeoutBuffer? autoSelectFamily? autoSelectFamilyAttemptTimeout? blockList? diff --git a/docs/interfaces/_internal_.ArrayIterator.html b/docs/interfaces/_internal_.ArrayIterator.html index f6042f9a..5fc242bd 100644 --- a/docs/interfaces/_internal_.ArrayIterator.html +++ b/docs/interfaces/_internal_.ArrayIterator.html @@ -1,4 +1,4 @@ -ArrayIterator | ts-lambda-api - v2.5.3
                                                                                                            ts-lambda-api - v2.5.3
                                                                                                              Preparing search index...

                                                                                                              Interface ArrayIterator<T>

                                                                                                              interface ArrayIterator<T> {
                                                                                                                  "[dispose]"(): void;
                                                                                                                  "[iterator]"(): ArrayIterator<T>;
                                                                                                                  next(...__namedParameters: [] | [unknown]): IteratorResult<T, any>;
                                                                                                                  return?(value?: any): IteratorResult<T, any>;
                                                                                                                  throw?(e?: any): IteratorResult<T, any>;
                                                                                                              }

                                                                                                              Type Parameters

                                                                                                              • T

                                                                                                              Hierarchy

                                                                                                              Index

                                                                                                              Methods

                                                                                                              [dispose] +ArrayIterator | ts-lambda-api - v2.5.3
                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                Preparing search index...

                                                                                                                Interface ArrayIterator<T>

                                                                                                                interface ArrayIterator<T> {
                                                                                                                    "[dispose]"(): void;
                                                                                                                    "[iterator]"(): ArrayIterator<T>;
                                                                                                                    next(...__namedParameters: [] | [unknown]): IteratorResult<T, any>;
                                                                                                                    return?(value?: any): IteratorResult<T, any>;
                                                                                                                    throw?(e?: any): IteratorResult<T, any>;
                                                                                                                }

                                                                                                                Type Parameters

                                                                                                                • T

                                                                                                                Hierarchy

                                                                                                                Index

                                                                                                                Methods

                                                                                                                [dispose] [iterator] next return? diff --git a/docs/interfaces/_internal_.AsyncGenerator.html b/docs/interfaces/_internal_.AsyncGenerator.html index 04af5ff8..7f85eb50 100644 --- a/docs/interfaces/_internal_.AsyncGenerator.html +++ b/docs/interfaces/_internal_.AsyncGenerator.html @@ -1,4 +1,4 @@ -AsyncGenerator | ts-lambda-api - v2.5.3
                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                  Preparing search index...

                                                                                                                  Interface AsyncGenerator<T, TReturn, TNext>

                                                                                                                  interface AsyncGenerator<T = unknown, TReturn = any, TNext = any> {
                                                                                                                      "[asyncDispose]"(): PromiseLike<void>;
                                                                                                                      "[asyncIterator]"(): AsyncGenerator<T, TReturn, TNext>;
                                                                                                                      next(
                                                                                                                          ...__namedParameters: [] | [TNext],
                                                                                                                      ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                      return(
                                                                                                                          value: TReturn | PromiseLike<TReturn>,
                                                                                                                      ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                      throw(e: any): Promise<IteratorResult<T, TReturn>>;
                                                                                                                  }

                                                                                                                  Type Parameters

                                                                                                                  • T = unknown
                                                                                                                  • TReturn = any
                                                                                                                  • TNext = any

                                                                                                                  Hierarchy

                                                                                                                  Index

                                                                                                                  Methods

                                                                                                                  [asyncDispose] +AsyncGenerator | ts-lambda-api - v2.5.3
                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                    Preparing search index...

                                                                                                                    Interface AsyncGenerator<T, TReturn, TNext>

                                                                                                                    interface AsyncGenerator<T = unknown, TReturn = any, TNext = any> {
                                                                                                                        "[asyncDispose]"(): PromiseLike<void>;
                                                                                                                        "[asyncIterator]"(): AsyncGenerator<T, TReturn, TNext>;
                                                                                                                        next(
                                                                                                                            ...__namedParameters: [] | [TNext],
                                                                                                                        ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                        return(
                                                                                                                            value: TReturn | PromiseLike<TReturn>,
                                                                                                                        ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                        throw(e: any): Promise<IteratorResult<T, TReturn>>;
                                                                                                                    }

                                                                                                                    Type Parameters

                                                                                                                    • T = unknown
                                                                                                                    • TReturn = any
                                                                                                                    • TNext = any

                                                                                                                    Hierarchy

                                                                                                                    Index

                                                                                                                    Methods

                                                                                                                    [asyncDispose] [asyncIterator] next return diff --git a/docs/interfaces/_internal_.AsyncIterableIterator.html b/docs/interfaces/_internal_.AsyncIterableIterator.html index 94e811fc..c9dab267 100644 --- a/docs/interfaces/_internal_.AsyncIterableIterator.html +++ b/docs/interfaces/_internal_.AsyncIterableIterator.html @@ -1,5 +1,5 @@ AsyncIterableIterator | ts-lambda-api - v2.5.3
                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                      Preparing search index...

                                                                                                                      Interface AsyncIterableIterator<T, TReturn, TNext>

                                                                                                                      Describes a user-defined AsyncIterator that is also async iterable.

                                                                                                                      -
                                                                                                                      interface AsyncIterableIterator<T, TReturn = any, TNext = any> {
                                                                                                                          "[asyncIterator]"(): AsyncIterableIterator<T, TReturn, TNext>;
                                                                                                                          next(
                                                                                                                              ...__namedParameters: [] | [TNext],
                                                                                                                          ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                          return?(
                                                                                                                              value?: TReturn | PromiseLike<TReturn>,
                                                                                                                          ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                          throw?(e?: any): Promise<IteratorResult<T, TReturn>>;
                                                                                                                      }

                                                                                                                      Type Parameters

                                                                                                                      • T
                                                                                                                      • TReturn = any
                                                                                                                      • TNext = any

                                                                                                                      Hierarchy (View Summary)

                                                                                                                      Index

                                                                                                                      Methods

                                                                                                                      [asyncIterator] +
                                                                                                                      interface AsyncIterableIterator<T, TReturn = any, TNext = any> {
                                                                                                                          "[asyncIterator]"(): AsyncIterableIterator<T, TReturn, TNext>;
                                                                                                                          next(
                                                                                                                              ...__namedParameters: [] | [TNext],
                                                                                                                          ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                          return?(
                                                                                                                              value?: TReturn | PromiseLike<TReturn>,
                                                                                                                          ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                          throw?(e?: any): Promise<IteratorResult<T, TReturn>>;
                                                                                                                      }

                                                                                                                      Type Parameters

                                                                                                                      • T
                                                                                                                      • TReturn = any
                                                                                                                      • TNext = any

                                                                                                                      Hierarchy (View Summary)

                                                                                                                      Index

                                                                                                                      Methods

                                                                                                                      [asyncIterator] next return? throw? diff --git a/docs/interfaces/_internal_.AsyncIterator.html b/docs/interfaces/_internal_.AsyncIterator.html index fe7cffeb..9351b128 100644 --- a/docs/interfaces/_internal_.AsyncIterator.html +++ b/docs/interfaces/_internal_.AsyncIterator.html @@ -1,4 +1,4 @@ -AsyncIterator | ts-lambda-api - v2.5.3
                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                        Preparing search index...

                                                                                                                        Interface AsyncIterator<T, TReturn, TNext>

                                                                                                                        interface AsyncIterator<T, TReturn = any, TNext = any> {
                                                                                                                            next(
                                                                                                                                ...__namedParameters: [] | [TNext],
                                                                                                                            ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                            return?(
                                                                                                                                value?: TReturn | PromiseLike<TReturn>,
                                                                                                                            ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                            throw?(e?: any): Promise<IteratorResult<T, TReturn>>;
                                                                                                                        }

                                                                                                                        Type Parameters

                                                                                                                        • T
                                                                                                                        • TReturn = any
                                                                                                                        • TNext = any

                                                                                                                        Hierarchy (View Summary)

                                                                                                                        Index

                                                                                                                        Methods

                                                                                                                        next +AsyncIterator | ts-lambda-api - v2.5.3
                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                          Preparing search index...

                                                                                                                          Interface AsyncIterator<T, TReturn, TNext>

                                                                                                                          interface AsyncIterator<T, TReturn = any, TNext = any> {
                                                                                                                              next(
                                                                                                                                  ...__namedParameters: [] | [TNext],
                                                                                                                              ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                              return?(
                                                                                                                                  value?: TReturn | PromiseLike<TReturn>,
                                                                                                                              ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                              throw?(e?: any): Promise<IteratorResult<T, TReturn>>;
                                                                                                                          }

                                                                                                                          Type Parameters

                                                                                                                          • T
                                                                                                                          • TReturn = any
                                                                                                                          • TNext = any

                                                                                                                          Hierarchy (View Summary)

                                                                                                                          Index

                                                                                                                          Methods

                                                                                                                          next return? throw?

                                                                                                                          Methods

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          On This Page

                                                                                                                          Methods
                                                                                                                          diff --git a/docs/interfaces/_internal_.AsyncResourceOptions.html b/docs/interfaces/_internal_.AsyncResourceOptions.html index 1e7b10c4..9708d52a 100644 --- a/docs/interfaces/_internal_.AsyncResourceOptions.html +++ b/docs/interfaces/_internal_.AsyncResourceOptions.html @@ -1,4 +1,4 @@ -AsyncResourceOptions | ts-lambda-api - v2.5.3
                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                            Preparing search index...

                                                                                                                            Interface AsyncResourceOptions

                                                                                                                            interface AsyncResourceOptions {
                                                                                                                                requireManualDestroy?: boolean;
                                                                                                                                triggerAsyncId?: number;
                                                                                                                            }

                                                                                                                            Hierarchy (View Summary)

                                                                                                                            Index

                                                                                                                            Properties

                                                                                                                            requireManualDestroy? +AsyncResourceOptions | ts-lambda-api - v2.5.3
                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                              Preparing search index...

                                                                                                                              Interface AsyncResourceOptions

                                                                                                                              interface AsyncResourceOptions {
                                                                                                                                  requireManualDestroy?: boolean;
                                                                                                                                  triggerAsyncId?: number;
                                                                                                                              }

                                                                                                                              Hierarchy (View Summary)

                                                                                                                              Index

                                                                                                                              Properties

                                                                                                                              requireManualDestroy? triggerAsyncId?

                                                                                                                              Properties

                                                                                                                              requireManualDestroy?: boolean

                                                                                                                              Disables automatic emitDestroy when the object is garbage collected. This usually does not need to be set (even if emitDestroy is called diff --git a/docs/interfaces/_internal_.AwsCredentialIdentity.html b/docs/interfaces/_internal_.AwsCredentialIdentity.html index 80424f54..e089d562 100644 --- a/docs/interfaces/_internal_.AwsCredentialIdentity.html +++ b/docs/interfaces/_internal_.AwsCredentialIdentity.html @@ -1,4 +1,4 @@ -AwsCredentialIdentity | ts-lambda-api - v2.5.3

                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                Preparing search index...

                                                                                                                                Interface AwsCredentialIdentity

                                                                                                                                interface AwsCredentialIdentity {
                                                                                                                                    accessKeyId: string;
                                                                                                                                    accountId?: string;
                                                                                                                                    credentialScope?: string;
                                                                                                                                    expiration?: Date;
                                                                                                                                    secretAccessKey: string;
                                                                                                                                    sessionToken?: string;
                                                                                                                                }

                                                                                                                                Hierarchy (View Summary)

                                                                                                                                Index

                                                                                                                                Properties

                                                                                                                                accessKeyId +AwsCredentialIdentity | ts-lambda-api - v2.5.3
                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                  Preparing search index...

                                                                                                                                  Interface AwsCredentialIdentity

                                                                                                                                  interface AwsCredentialIdentity {
                                                                                                                                      accessKeyId: string;
                                                                                                                                      accountId?: string;
                                                                                                                                      credentialScope?: string;
                                                                                                                                      expiration?: Date;
                                                                                                                                      secretAccessKey: string;
                                                                                                                                      sessionToken?: string;
                                                                                                                                  }

                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                  Index

                                                                                                                                  Properties

                                                                                                                                  accessKeyId accountId? credentialScope? expiration? diff --git a/docs/interfaces/_internal_.AwsRegionExtensionConfiguration.html b/docs/interfaces/_internal_.AwsRegionExtensionConfiguration.html index d71d4b42..4c096267 100644 --- a/docs/interfaces/_internal_.AwsRegionExtensionConfiguration.html +++ b/docs/interfaces/_internal_.AwsRegionExtensionConfiguration.html @@ -1,3 +1,3 @@ -AwsRegionExtensionConfiguration | ts-lambda-api - v2.5.3
                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                    Preparing search index...

                                                                                                                                    Interface AwsRegionExtensionConfigurationInternal

                                                                                                                                    interface AwsRegionExtensionConfiguration {
                                                                                                                                        region(): Provider<string>;
                                                                                                                                        setRegion(region: Provider<string>): void;
                                                                                                                                    }

                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                    Index

                                                                                                                                    Methods

                                                                                                                                    region +AwsRegionExtensionConfiguration | ts-lambda-api - v2.5.3
                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                      Preparing search index...

                                                                                                                                      Interface AwsRegionExtensionConfigurationInternal

                                                                                                                                      interface AwsRegionExtensionConfiguration {
                                                                                                                                          region(): Provider<string>;
                                                                                                                                          setRegion(region: Provider<string>): void;
                                                                                                                                      }

                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                      Index

                                                                                                                                      Methods

                                                                                                                                      region setRegion

                                                                                                                                      Methods

                                                                                                                                      • Returns Provider<string>

                                                                                                                                      • Parameters

                                                                                                                                        Returns void

                                                                                                                                      Settings

                                                                                                                                      Member Visibility

                                                                                                                                      On This Page

                                                                                                                                      Methods
                                                                                                                                      diff --git a/docs/interfaces/_internal_.AwsSdkSigV4AAuthInputConfig.html b/docs/interfaces/_internal_.AwsSdkSigV4AAuthInputConfig.html index 089177b2..f13ab870 100644 --- a/docs/interfaces/_internal_.AwsSdkSigV4AAuthInputConfig.html +++ b/docs/interfaces/_internal_.AwsSdkSigV4AAuthInputConfig.html @@ -1,4 +1,4 @@ -AwsSdkSigV4AAuthInputConfig | ts-lambda-api - v2.5.3
                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                        Preparing search index...

                                                                                                                                        Interface AwsSdkSigV4AAuthInputConfig

                                                                                                                                        interface AwsSdkSigV4AAuthInputConfig {
                                                                                                                                            sigv4aSigningRegionSet?: string[] | Provider<string[]>;
                                                                                                                                        }

                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                        Index

                                                                                                                                        Properties

                                                                                                                                        sigv4aSigningRegionSet? +AwsSdkSigV4AAuthInputConfig | ts-lambda-api - v2.5.3
                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                          Preparing search index...

                                                                                                                                          Interface AwsSdkSigV4AAuthInputConfig

                                                                                                                                          interface AwsSdkSigV4AAuthInputConfig {
                                                                                                                                              sigv4aSigningRegionSet?: string[] | Provider<string[]>;
                                                                                                                                          }

                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                          Index

                                                                                                                                          Properties

                                                                                                                                          sigv4aSigningRegionSet?

                                                                                                                                          Properties

                                                                                                                                          sigv4aSigningRegionSet?: string[] | Provider<string[]>

                                                                                                                                          This option will override the AWS sigv4a signing regionSet from any other source.

                                                                                                                                          The lookup order is:

                                                                                                                                          diff --git a/docs/interfaces/_internal_.AwsSdkSigV4AuthInputConfig.html b/docs/interfaces/_internal_.AwsSdkSigV4AuthInputConfig.html index cdd69652..6e203468 100644 --- a/docs/interfaces/_internal_.AwsSdkSigV4AuthInputConfig.html +++ b/docs/interfaces/_internal_.AwsSdkSigV4AuthInputConfig.html @@ -1,4 +1,4 @@ -AwsSdkSigV4AuthInputConfig | ts-lambda-api - v2.5.3
                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                            Preparing search index...

                                                                                                                                            Interface AwsSdkSigV4AuthInputConfig

                                                                                                                                            interface AwsSdkSigV4AuthInputConfig {
                                                                                                                                                credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                signer?:
                                                                                                                                                    | RequestSigner
                                                                                                                                                    | ((authScheme?: AuthScheme) => Promise<RequestSigner>);
                                                                                                                                                signerConstructor?: new (
                                                                                                                                                    options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                ) => RequestSigner;
                                                                                                                                                signingEscapePath?: boolean;
                                                                                                                                                signingRegion?: string;
                                                                                                                                                systemClockOffset?: number;
                                                                                                                                            }

                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                            Index

                                                                                                                                            Properties

                                                                                                                                            credentials? +AwsSdkSigV4AuthInputConfig | ts-lambda-api - v2.5.3
                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                              Preparing search index...

                                                                                                                                              Interface AwsSdkSigV4AuthInputConfig

                                                                                                                                              interface AwsSdkSigV4AuthInputConfig {
                                                                                                                                                  credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                  signer?:
                                                                                                                                                      | RequestSigner
                                                                                                                                                      | ((authScheme?: AuthScheme) => Promise<RequestSigner>);
                                                                                                                                                  signerConstructor?: new (
                                                                                                                                                      options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                  ) => RequestSigner;
                                                                                                                                                  signingEscapePath?: boolean;
                                                                                                                                                  signingRegion?: string;
                                                                                                                                                  systemClockOffset?: number;
                                                                                                                                              }

                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                              Index

                                                                                                                                              Properties

                                                                                                                                              credentials? signer? signerConstructor? signingEscapePath? diff --git a/docs/interfaces/_internal_.BaseMultipleResolvedValueMetadataInjectOptions.html b/docs/interfaces/_internal_.BaseMultipleResolvedValueMetadataInjectOptions.html index 5d96db4d..b3bb8289 100644 --- a/docs/interfaces/_internal_.BaseMultipleResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.BaseMultipleResolvedValueMetadataInjectOptions.html @@ -1,3 +1,3 @@ -BaseMultipleResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.3
                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                Preparing search index...

                                                                                                                                                Interface BaseMultipleResolvedValueMetadataInjectOptions

                                                                                                                                                interface BaseMultipleResolvedValueMetadataInjectOptions {
                                                                                                                                                    chained?: boolean;
                                                                                                                                                    isMultiple: true;
                                                                                                                                                }

                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                Index

                                                                                                                                                Properties

                                                                                                                                                chained? +BaseMultipleResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.3
                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                  Preparing search index...

                                                                                                                                                  Interface BaseMultipleResolvedValueMetadataInjectOptions

                                                                                                                                                  interface BaseMultipleResolvedValueMetadataInjectOptions {
                                                                                                                                                      chained?: boolean;
                                                                                                                                                      isMultiple: true;
                                                                                                                                                  }

                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                  Index

                                                                                                                                                  Properties

                                                                                                                                                  chained? isMultiple

                                                                                                                                                  Properties

                                                                                                                                                  chained?: boolean
                                                                                                                                                  isMultiple: true

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Properties
                                                                                                                                                  diff --git a/docs/interfaces/_internal_.BaseOperation.html b/docs/interfaces/_internal_.BaseOperation.html index 26bf3c62..3150624f 100644 --- a/docs/interfaces/_internal_.BaseOperation.html +++ b/docs/interfaces/_internal_.BaseOperation.html @@ -1,2 +1,2 @@ -BaseOperation | ts-lambda-api - v2.5.3
                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                    Preparing search index...

                                                                                                                                                    Interface BaseOperation

                                                                                                                                                    interface BaseOperation {
                                                                                                                                                        path: string;
                                                                                                                                                    }

                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                    Index

                                                                                                                                                    Properties

                                                                                                                                                    path +BaseOperation | ts-lambda-api - v2.5.3
                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                      Preparing search index...

                                                                                                                                                      Interface BaseOperation

                                                                                                                                                      interface BaseOperation {
                                                                                                                                                          path: string;
                                                                                                                                                      }

                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                      Index

                                                                                                                                                      Properties

                                                                                                                                                      path

                                                                                                                                                      Properties

                                                                                                                                                      path: string

                                                                                                                                                      Settings

                                                                                                                                                      Member Visibility

                                                                                                                                                      On This Page

                                                                                                                                                      Properties
                                                                                                                                                      diff --git a/docs/interfaces/_internal_.BaseOptionalResolvedValueMetadataInjectOptions.html b/docs/interfaces/_internal_.BaseOptionalResolvedValueMetadataInjectOptions.html index 1dfe913a..94b918dc 100644 --- a/docs/interfaces/_internal_.BaseOptionalResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.BaseOptionalResolvedValueMetadataInjectOptions.html @@ -1,2 +1,2 @@ -BaseOptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.3
                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                        Preparing search index...

                                                                                                                                                        Interface BaseOptionalResolvedValueMetadataInjectOptions

                                                                                                                                                        interface BaseOptionalResolvedValueMetadataInjectOptions {
                                                                                                                                                            optional: true;
                                                                                                                                                        }

                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                        Index

                                                                                                                                                        Properties

                                                                                                                                                        optional +BaseOptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.3
                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                          Preparing search index...

                                                                                                                                                          Interface BaseOptionalResolvedValueMetadataInjectOptions

                                                                                                                                                          interface BaseOptionalResolvedValueMetadataInjectOptions {
                                                                                                                                                              optional: true;
                                                                                                                                                          }

                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                          Index

                                                                                                                                                          Properties

                                                                                                                                                          optional

                                                                                                                                                          Properties

                                                                                                                                                          optional: true

                                                                                                                                                          Settings

                                                                                                                                                          Member Visibility

                                                                                                                                                          On This Page

                                                                                                                                                          Properties
                                                                                                                                                          diff --git a/docs/interfaces/_internal_.BaseParameterObject.html b/docs/interfaces/_internal_.BaseParameterObject.html index 8b310252..281cf81d 100644 --- a/docs/interfaces/_internal_.BaseParameterObject.html +++ b/docs/interfaces/_internal_.BaseParameterObject.html @@ -1,4 +1,4 @@ -BaseParameterObject | ts-lambda-api - v2.5.3
                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                            Preparing search index...

                                                                                                                                                            Interface BaseParameterObject

                                                                                                                                                            interface BaseParameterObject {
                                                                                                                                                                allowEmptyValue?: boolean;
                                                                                                                                                                allowReserved?: boolean;
                                                                                                                                                                content?: ContentObject;
                                                                                                                                                                deprecated?: boolean;
                                                                                                                                                                description?: string;
                                                                                                                                                                example?: any;
                                                                                                                                                                examples?: { [param: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                explode?: boolean;
                                                                                                                                                                required?: boolean;
                                                                                                                                                                schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                style?: ParameterStyle;
                                                                                                                                                                [extensionName: `x-${string}`]: any;
                                                                                                                                                            }

                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                            Indexable

                                                                                                                                                            • [extensionName: `x-${string}`]: any
                                                                                                                                                            Index

                                                                                                                                                            Properties

                                                                                                                                                            allowEmptyValue? +BaseParameterObject | ts-lambda-api - v2.5.3
                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                              Preparing search index...

                                                                                                                                                              Interface BaseParameterObject

                                                                                                                                                              interface BaseParameterObject {
                                                                                                                                                                  allowEmptyValue?: boolean;
                                                                                                                                                                  allowReserved?: boolean;
                                                                                                                                                                  content?: ContentObject;
                                                                                                                                                                  deprecated?: boolean;
                                                                                                                                                                  description?: string;
                                                                                                                                                                  example?: any;
                                                                                                                                                                  examples?: { [param: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                  explode?: boolean;
                                                                                                                                                                  required?: boolean;
                                                                                                                                                                  schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                  style?: ParameterStyle;
                                                                                                                                                                  [extensionName: `x-${string}`]: any;
                                                                                                                                                              }

                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                              Indexable

                                                                                                                                                              • [extensionName: `x-${string}`]: any
                                                                                                                                                              Index

                                                                                                                                                              Properties

                                                                                                                                                              allowEmptyValue? allowReserved? content? deprecated? diff --git a/docs/interfaces/_internal_.BaseResolvedValueMetadataInjectOptions.html b/docs/interfaces/_internal_.BaseResolvedValueMetadataInjectOptions.html index 1991ffcc..768b43e3 100644 --- a/docs/interfaces/_internal_.BaseResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.BaseResolvedValueMetadataInjectOptions.html @@ -1,4 +1,4 @@ -BaseResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.3
                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                Preparing search index...

                                                                                                                                                                Interface BaseResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                interface BaseResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                    name?: MetadataName;
                                                                                                                                                                    serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                    tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                }

                                                                                                                                                                Type Parameters

                                                                                                                                                                • T

                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                Index

                                                                                                                                                                Properties

                                                                                                                                                                name? +BaseResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                  Preparing search index...

                                                                                                                                                                  Interface BaseResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                  interface BaseResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                      name?: MetadataName;
                                                                                                                                                                      serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                      tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                  }

                                                                                                                                                                  Type Parameters

                                                                                                                                                                  • T

                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                  Index

                                                                                                                                                                  Properties

                                                                                                                                                                  name? serviceIdentifier tags?

                                                                                                                                                                  Properties

                                                                                                                                                                  name?: MetadataName
                                                                                                                                                                  serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>
                                                                                                                                                                  tags?: ResolvedValueMetadataInjectTagOptions[]

                                                                                                                                                                  Settings

                                                                                                                                                                  Member Visibility

                                                                                                                                                                  On This Page

                                                                                                                                                                  Properties
                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.BindInFluentSyntax.html b/docs/interfaces/_internal_.BindInFluentSyntax.html index 13cc4754..9f038072 100644 --- a/docs/interfaces/_internal_.BindInFluentSyntax.html +++ b/docs/interfaces/_internal_.BindInFluentSyntax.html @@ -1,4 +1,4 @@ -BindInFluentSyntax | ts-lambda-api - v2.5.3
                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                    Preparing search index...

                                                                                                                                                                    Interface BindInFluentSyntax<T>

                                                                                                                                                                    interface BindInFluentSyntax<T> {
                                                                                                                                                                        getIdentifier(): BindingIdentifier;
                                                                                                                                                                        inRequestScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                        inSingletonScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                        inTransientScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                    }

                                                                                                                                                                    Type Parameters

                                                                                                                                                                    • T

                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                    Index

                                                                                                                                                                    Methods

                                                                                                                                                                    getIdentifier +BindInFluentSyntax | ts-lambda-api - v2.5.3
                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                      Preparing search index...

                                                                                                                                                                      Interface BindInFluentSyntax<T>

                                                                                                                                                                      interface BindInFluentSyntax<T> {
                                                                                                                                                                          getIdentifier(): BindingIdentifier;
                                                                                                                                                                          inRequestScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                          inSingletonScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                          inTransientScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                      }

                                                                                                                                                                      Type Parameters

                                                                                                                                                                      • T

                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                      Index

                                                                                                                                                                      Methods

                                                                                                                                                                      getIdentifier inRequestScope inSingletonScope inTransientScope diff --git a/docs/interfaces/_internal_.BindInWhenOnFluentSyntax.html b/docs/interfaces/_internal_.BindInWhenOnFluentSyntax.html index 15fc0c2d..77f01ddb 100644 --- a/docs/interfaces/_internal_.BindInWhenOnFluentSyntax.html +++ b/docs/interfaces/_internal_.BindInWhenOnFluentSyntax.html @@ -1,4 +1,4 @@ -BindInWhenOnFluentSyntax | ts-lambda-api - v2.5.3
                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        Interface BindInWhenOnFluentSyntax<T>

                                                                                                                                                                        interface BindInWhenOnFluentSyntax<T> {
                                                                                                                                                                            getIdentifier(): BindingIdentifier;
                                                                                                                                                                            inRequestScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                            inSingletonScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                            inTransientScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                            onActivation(activation: BindingActivation<T>): BindWhenFluentSyntax<T>;
                                                                                                                                                                            onDeactivation(
                                                                                                                                                                                deactivation: BindingDeactivation<T>,
                                                                                                                                                                            ): BindWhenFluentSyntax<T>;
                                                                                                                                                                            when(
                                                                                                                                                                                constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenAnyAncestor(
                                                                                                                                                                                constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenAnyAncestorIs(
                                                                                                                                                                                serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenAnyAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenAnyAncestorTagged(
                                                                                                                                                                                tag: MetadataTag,
                                                                                                                                                                                tagValue: unknown,
                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenDefault(): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenNoAncestor(
                                                                                                                                                                                constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenNoAncestorIs(
                                                                                                                                                                                serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenNoAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenNoAncestorTagged(
                                                                                                                                                                                tag: MetadataTag,
                                                                                                                                                                                tagValue: unknown,
                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenNoParent(
                                                                                                                                                                                constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenNoParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenNoParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenNoParentTagged(
                                                                                                                                                                                tag: MetadataTag,
                                                                                                                                                                                tagValue: unknown,
                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenParent(
                                                                                                                                                                                constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenParentTagged(
                                                                                                                                                                                tag: MetadataTag,
                                                                                                                                                                                tagValue: unknown,
                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                            whenTagged(tag: MetadataTag, tagValue: unknown): BindOnFluentSyntax<T>;
                                                                                                                                                                        }

                                                                                                                                                                        Type Parameters

                                                                                                                                                                        • T

                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                        Index

                                                                                                                                                                        Methods

                                                                                                                                                                        getIdentifier +BindInWhenOnFluentSyntax | ts-lambda-api - v2.5.3
                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                          Preparing search index...

                                                                                                                                                                          Interface BindInWhenOnFluentSyntax<T>

                                                                                                                                                                          interface BindInWhenOnFluentSyntax<T> {
                                                                                                                                                                              getIdentifier(): BindingIdentifier;
                                                                                                                                                                              inRequestScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                              inSingletonScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                              inTransientScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                              onActivation(activation: BindingActivation<T>): BindWhenFluentSyntax<T>;
                                                                                                                                                                              onDeactivation(
                                                                                                                                                                                  deactivation: BindingDeactivation<T>,
                                                                                                                                                                              ): BindWhenFluentSyntax<T>;
                                                                                                                                                                              when(
                                                                                                                                                                                  constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenAnyAncestor(
                                                                                                                                                                                  constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenAnyAncestorIs(
                                                                                                                                                                                  serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenAnyAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenAnyAncestorTagged(
                                                                                                                                                                                  tag: MetadataTag,
                                                                                                                                                                                  tagValue: unknown,
                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenDefault(): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenNoAncestor(
                                                                                                                                                                                  constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenNoAncestorIs(
                                                                                                                                                                                  serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenNoAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenNoAncestorTagged(
                                                                                                                                                                                  tag: MetadataTag,
                                                                                                                                                                                  tagValue: unknown,
                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenNoParent(
                                                                                                                                                                                  constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenNoParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenNoParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenNoParentTagged(
                                                                                                                                                                                  tag: MetadataTag,
                                                                                                                                                                                  tagValue: unknown,
                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenParent(
                                                                                                                                                                                  constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenParentTagged(
                                                                                                                                                                                  tag: MetadataTag,
                                                                                                                                                                                  tagValue: unknown,
                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                              whenTagged(tag: MetadataTag, tagValue: unknown): BindOnFluentSyntax<T>;
                                                                                                                                                                          }

                                                                                                                                                                          Type Parameters

                                                                                                                                                                          • T

                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                          Index

                                                                                                                                                                          Methods

                                                                                                                                                                          getIdentifier inRequestScope inSingletonScope inTransientScope diff --git a/docs/interfaces/_internal_.BindOnFluentSyntax.html b/docs/interfaces/_internal_.BindOnFluentSyntax.html index 19888daf..5a85ad65 100644 --- a/docs/interfaces/_internal_.BindOnFluentSyntax.html +++ b/docs/interfaces/_internal_.BindOnFluentSyntax.html @@ -1,4 +1,4 @@ -BindOnFluentSyntax | ts-lambda-api - v2.5.3
                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                            Preparing search index...

                                                                                                                                                                            Interface BindOnFluentSyntax<T>

                                                                                                                                                                            interface BindOnFluentSyntax<T> {
                                                                                                                                                                                getIdentifier(): BindingIdentifier;
                                                                                                                                                                                onActivation(activation: BindingActivation<T>): BindWhenFluentSyntax<T>;
                                                                                                                                                                                onDeactivation(
                                                                                                                                                                                    deactivation: BindingDeactivation<T>,
                                                                                                                                                                                ): BindWhenFluentSyntax<T>;
                                                                                                                                                                            }

                                                                                                                                                                            Type Parameters

                                                                                                                                                                            • T

                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                            Index

                                                                                                                                                                            Methods

                                                                                                                                                                            getIdentifier +BindOnFluentSyntax | ts-lambda-api - v2.5.3
                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                              Preparing search index...

                                                                                                                                                                              Interface BindOnFluentSyntax<T>

                                                                                                                                                                              interface BindOnFluentSyntax<T> {
                                                                                                                                                                                  getIdentifier(): BindingIdentifier;
                                                                                                                                                                                  onActivation(activation: BindingActivation<T>): BindWhenFluentSyntax<T>;
                                                                                                                                                                                  onDeactivation(
                                                                                                                                                                                      deactivation: BindingDeactivation<T>,
                                                                                                                                                                                  ): BindWhenFluentSyntax<T>;
                                                                                                                                                                              }

                                                                                                                                                                              Type Parameters

                                                                                                                                                                              • T

                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                              Index

                                                                                                                                                                              Methods

                                                                                                                                                                              getIdentifier onActivation onDeactivation

                                                                                                                                                                              Methods

                                                                                                                                                                              Settings

                                                                                                                                                                              Member Visibility

                                                                                                                                                                              On This Page

                                                                                                                                                                              Methods
                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.BindWhenFluentSyntax.html b/docs/interfaces/_internal_.BindWhenFluentSyntax.html index 8cadcfbe..9c2e9a1e 100644 --- a/docs/interfaces/_internal_.BindWhenFluentSyntax.html +++ b/docs/interfaces/_internal_.BindWhenFluentSyntax.html @@ -1,4 +1,4 @@ -BindWhenFluentSyntax | ts-lambda-api - v2.5.3
                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Interface BindWhenFluentSyntax<T>

                                                                                                                                                                                interface BindWhenFluentSyntax<T> {
                                                                                                                                                                                    getIdentifier(): BindingIdentifier;
                                                                                                                                                                                    when(
                                                                                                                                                                                        constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenAnyAncestor(
                                                                                                                                                                                        constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenAnyAncestorIs(
                                                                                                                                                                                        serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenAnyAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenAnyAncestorTagged(
                                                                                                                                                                                        tag: MetadataTag,
                                                                                                                                                                                        tagValue: unknown,
                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenDefault(): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenNoAncestor(
                                                                                                                                                                                        constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenNoAncestorIs(
                                                                                                                                                                                        serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenNoAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenNoAncestorTagged(
                                                                                                                                                                                        tag: MetadataTag,
                                                                                                                                                                                        tagValue: unknown,
                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenNoParent(
                                                                                                                                                                                        constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenNoParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenNoParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenNoParentTagged(
                                                                                                                                                                                        tag: MetadataTag,
                                                                                                                                                                                        tagValue: unknown,
                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenParent(
                                                                                                                                                                                        constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenParentTagged(
                                                                                                                                                                                        tag: MetadataTag,
                                                                                                                                                                                        tagValue: unknown,
                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                    whenTagged(tag: MetadataTag, tagValue: unknown): BindOnFluentSyntax<T>;
                                                                                                                                                                                }

                                                                                                                                                                                Type Parameters

                                                                                                                                                                                • T

                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                Index

                                                                                                                                                                                Methods

                                                                                                                                                                                getIdentifier +BindWhenFluentSyntax | ts-lambda-api - v2.5.3
                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                  Interface BindWhenFluentSyntax<T>

                                                                                                                                                                                  interface BindWhenFluentSyntax<T> {
                                                                                                                                                                                      getIdentifier(): BindingIdentifier;
                                                                                                                                                                                      when(
                                                                                                                                                                                          constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenAnyAncestor(
                                                                                                                                                                                          constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenAnyAncestorIs(
                                                                                                                                                                                          serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenAnyAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenAnyAncestorTagged(
                                                                                                                                                                                          tag: MetadataTag,
                                                                                                                                                                                          tagValue: unknown,
                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenDefault(): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenNoAncestor(
                                                                                                                                                                                          constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenNoAncestorIs(
                                                                                                                                                                                          serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenNoAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenNoAncestorTagged(
                                                                                                                                                                                          tag: MetadataTag,
                                                                                                                                                                                          tagValue: unknown,
                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenNoParent(
                                                                                                                                                                                          constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenNoParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenNoParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenNoParentTagged(
                                                                                                                                                                                          tag: MetadataTag,
                                                                                                                                                                                          tagValue: unknown,
                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenParent(
                                                                                                                                                                                          constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenParentTagged(
                                                                                                                                                                                          tag: MetadataTag,
                                                                                                                                                                                          tagValue: unknown,
                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                      whenTagged(tag: MetadataTag, tagValue: unknown): BindOnFluentSyntax<T>;
                                                                                                                                                                                  }

                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                  • T

                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                  Index

                                                                                                                                                                                  Methods

                                                                                                                                                                                  getIdentifier when whenAnyAncestor whenAnyAncestorIs diff --git a/docs/interfaces/_internal_.BindWhenOnFluentSyntax.html b/docs/interfaces/_internal_.BindWhenOnFluentSyntax.html index 2ef54b98..919dc411 100644 --- a/docs/interfaces/_internal_.BindWhenOnFluentSyntax.html +++ b/docs/interfaces/_internal_.BindWhenOnFluentSyntax.html @@ -1,4 +1,4 @@ -BindWhenOnFluentSyntax | ts-lambda-api - v2.5.3
                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                    Interface BindWhenOnFluentSyntax<T>

                                                                                                                                                                                    interface BindWhenOnFluentSyntax<T> {
                                                                                                                                                                                        getIdentifier(): BindingIdentifier;
                                                                                                                                                                                        onActivation(activation: BindingActivation<T>): BindWhenFluentSyntax<T>;
                                                                                                                                                                                        onDeactivation(
                                                                                                                                                                                            deactivation: BindingDeactivation<T>,
                                                                                                                                                                                        ): BindWhenFluentSyntax<T>;
                                                                                                                                                                                        when(
                                                                                                                                                                                            constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                        ): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenAnyAncestor(
                                                                                                                                                                                            constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                        ): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenAnyAncestorIs(
                                                                                                                                                                                            serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                        ): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenAnyAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenAnyAncestorTagged(
                                                                                                                                                                                            tag: MetadataTag,
                                                                                                                                                                                            tagValue: unknown,
                                                                                                                                                                                        ): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenDefault(): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenNoAncestor(
                                                                                                                                                                                            constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                        ): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenNoAncestorIs(
                                                                                                                                                                                            serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                        ): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenNoAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenNoAncestorTagged(
                                                                                                                                                                                            tag: MetadataTag,
                                                                                                                                                                                            tagValue: unknown,
                                                                                                                                                                                        ): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenNoParent(
                                                                                                                                                                                            constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                        ): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenNoParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenNoParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenNoParentTagged(
                                                                                                                                                                                            tag: MetadataTag,
                                                                                                                                                                                            tagValue: unknown,
                                                                                                                                                                                        ): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenParent(
                                                                                                                                                                                            constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                        ): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenParentTagged(
                                                                                                                                                                                            tag: MetadataTag,
                                                                                                                                                                                            tagValue: unknown,
                                                                                                                                                                                        ): BindOnFluentSyntax<T>;
                                                                                                                                                                                        whenTagged(tag: MetadataTag, tagValue: unknown): BindOnFluentSyntax<T>;
                                                                                                                                                                                    }

                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                    • T

                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                    Index

                                                                                                                                                                                    Methods

                                                                                                                                                                                    getIdentifier +BindWhenOnFluentSyntax | ts-lambda-api - v2.5.3
                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                      Interface BindWhenOnFluentSyntax<T>

                                                                                                                                                                                      interface BindWhenOnFluentSyntax<T> {
                                                                                                                                                                                          getIdentifier(): BindingIdentifier;
                                                                                                                                                                                          onActivation(activation: BindingActivation<T>): BindWhenFluentSyntax<T>;
                                                                                                                                                                                          onDeactivation(
                                                                                                                                                                                              deactivation: BindingDeactivation<T>,
                                                                                                                                                                                          ): BindWhenFluentSyntax<T>;
                                                                                                                                                                                          when(
                                                                                                                                                                                              constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                          ): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenAnyAncestor(
                                                                                                                                                                                              constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                          ): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenAnyAncestorIs(
                                                                                                                                                                                              serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                          ): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenAnyAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenAnyAncestorTagged(
                                                                                                                                                                                              tag: MetadataTag,
                                                                                                                                                                                              tagValue: unknown,
                                                                                                                                                                                          ): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenDefault(): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenNoAncestor(
                                                                                                                                                                                              constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                          ): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenNoAncestorIs(
                                                                                                                                                                                              serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                          ): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenNoAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenNoAncestorTagged(
                                                                                                                                                                                              tag: MetadataTag,
                                                                                                                                                                                              tagValue: unknown,
                                                                                                                                                                                          ): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenNoParent(
                                                                                                                                                                                              constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                          ): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenNoParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenNoParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenNoParentTagged(
                                                                                                                                                                                              tag: MetadataTag,
                                                                                                                                                                                              tagValue: unknown,
                                                                                                                                                                                          ): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenParent(
                                                                                                                                                                                              constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                          ): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenParentTagged(
                                                                                                                                                                                              tag: MetadataTag,
                                                                                                                                                                                              tagValue: unknown,
                                                                                                                                                                                          ): BindOnFluentSyntax<T>;
                                                                                                                                                                                          whenTagged(tag: MetadataTag, tagValue: unknown): BindOnFluentSyntax<T>;
                                                                                                                                                                                      }

                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                      • T

                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                      Index

                                                                                                                                                                                      Methods

                                                                                                                                                                                      getIdentifier onActivation onDeactivation when diff --git a/docs/interfaces/_internal_.BoundServiceSyntax.html b/docs/interfaces/_internal_.BoundServiceSyntax.html index 0bb4b52a..ece8a44c 100644 --- a/docs/interfaces/_internal_.BoundServiceSyntax.html +++ b/docs/interfaces/_internal_.BoundServiceSyntax.html @@ -1,2 +1,2 @@ -BoundServiceSyntax | ts-lambda-api - v2.5.3
                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        Interface BoundServiceSyntax

                                                                                                                                                                                        interface BoundServiceSyntax {
                                                                                                                                                                                            getIdentifier(): BindingIdentifier;
                                                                                                                                                                                        }

                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                        Index

                                                                                                                                                                                        Methods

                                                                                                                                                                                        getIdentifier +BoundServiceSyntax | ts-lambda-api - v2.5.3
                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                          Interface BoundServiceSyntax

                                                                                                                                                                                          interface BoundServiceSyntax {
                                                                                                                                                                                              getIdentifier(): BindingIdentifier;
                                                                                                                                                                                          }

                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                          Index

                                                                                                                                                                                          Methods

                                                                                                                                                                                          getIdentifier

                                                                                                                                                                                          Methods

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          Methods
                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.CallbackObject.html b/docs/interfaces/_internal_.CallbackObject.html index bdefdb06..673c0f2a 100644 --- a/docs/interfaces/_internal_.CallbackObject.html +++ b/docs/interfaces/_internal_.CallbackObject.html @@ -1 +1 @@ -CallbackObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            Interface CallbackObject

                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                            Indexable

                                                                                                                                                                                            • [name: string]: any
                                                                                                                                                                                            • [extensionName: `x-${string}`]: any

                                                                                                                                                                                            Settings

                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                            +CallbackObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                              Interface CallbackObject

                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                              Indexable

                                                                                                                                                                                              • [name: string]: any
                                                                                                                                                                                              • [extensionName: `x-${string}`]: any

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.CallbacksObject.html b/docs/interfaces/_internal_.CallbacksObject.html index d472759b..7862c608 100644 --- a/docs/interfaces/_internal_.CallbacksObject.html +++ b/docs/interfaces/_internal_.CallbacksObject.html @@ -1 +1 @@ -CallbacksObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                Interface CallbacksObject

                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                Indexable

                                                                                                                                                                                                • [name: string]: any
                                                                                                                                                                                                • [extensionName: `x-${string}`]: any

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                +CallbacksObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                  Interface CallbacksObject

                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                  • [name: string]: any
                                                                                                                                                                                                  • [extensionName: `x-${string}`]: any

                                                                                                                                                                                                  Settings

                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.ChecksumConfiguration.html b/docs/interfaces/_internal_.ChecksumConfiguration.html index ee619eb5..5a274d4b 100644 --- a/docs/interfaces/_internal_.ChecksumConfiguration.html +++ b/docs/interfaces/_internal_.ChecksumConfiguration.html @@ -1,3 +1,3 @@ -ChecksumConfiguration | ts-lambda-api - v2.5.3
                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                    Interface ChecksumConfigurationInternal

                                                                                                                                                                                                    interface ChecksumConfiguration {
                                                                                                                                                                                                        addChecksumAlgorithm(algo: ChecksumAlgorithm): void;
                                                                                                                                                                                                        checksumAlgorithms(): ChecksumAlgorithm[];
                                                                                                                                                                                                        [key: string]: any;
                                                                                                                                                                                                        [key: number]: any;
                                                                                                                                                                                                    }

                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                    • [key: string]: any
                                                                                                                                                                                                    • [key: number]: any
                                                                                                                                                                                                    Index

                                                                                                                                                                                                    Methods

                                                                                                                                                                                                    addChecksumAlgorithm +ChecksumConfiguration | ts-lambda-api - v2.5.3
                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                      Interface ChecksumConfigurationInternal

                                                                                                                                                                                                      interface ChecksumConfiguration {
                                                                                                                                                                                                          addChecksumAlgorithm(algo: ChecksumAlgorithm): void;
                                                                                                                                                                                                          checksumAlgorithms(): ChecksumAlgorithm[];
                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                          [key: number]: any;
                                                                                                                                                                                                      }

                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                      • [key: string]: any
                                                                                                                                                                                                      • [key: number]: any
                                                                                                                                                                                                      Index

                                                                                                                                                                                                      Methods

                                                                                                                                                                                                      addChecksumAlgorithm checksumAlgorithms

                                                                                                                                                                                                      Methods

                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                      Methods
                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.ClientDefaults.html b/docs/interfaces/_internal_.ClientDefaults.html index aaa543d0..b9cb59e7 100644 --- a/docs/interfaces/_internal_.ClientDefaults.html +++ b/docs/interfaces/_internal_.ClientDefaults.html @@ -1,4 +1,4 @@ -ClientDefaults | ts-lambda-api - v2.5.3
                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                        Interface ClientDefaults

                                                                                                                                                                                                        interface ClientDefaults {
                                                                                                                                                                                                            apiVersion?: string;
                                                                                                                                                                                                            base64Decoder?: Decoder;
                                                                                                                                                                                                            base64Encoder?: Encoder;
                                                                                                                                                                                                            bodyLengthChecker?: BodyLengthCalculator;
                                                                                                                                                                                                            cacheMiddleware?: boolean;
                                                                                                                                                                                                            credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
                                                                                                                                                                                                            defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
                                                                                                                                                                                                            defaultUserAgentProvider?: Provider<UserAgent>;
                                                                                                                                                                                                            disableHostPrefix?: boolean;
                                                                                                                                                                                                            eventStreamSerdeProvider?: EventStreamSerdeProvider;
                                                                                                                                                                                                            extensions?: RuntimeExtension[];
                                                                                                                                                                                                            getAwsChunkedEncodingStream?: GetAwsChunkedEncodingStream;
                                                                                                                                                                                                            logger?: Logger;
                                                                                                                                                                                                            maxAttempts?: number | Provider<number>;
                                                                                                                                                                                                            md5?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                            profile?: string;
                                                                                                                                                                                                            protocol?: ClientProtocol<HttpRequest, HttpResponse>;
                                                                                                                                                                                                            region?: string | Provider<string>;
                                                                                                                                                                                                            requestHandler?: HttpHandlerUserInput;
                                                                                                                                                                                                            retryMode?: string | Provider<string>;
                                                                                                                                                                                                            runtime?: string;
                                                                                                                                                                                                            sdkStreamMixin?: SdkStreamMixinInjector;
                                                                                                                                                                                                            serviceId?: string;
                                                                                                                                                                                                            sha1?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                            sha256?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                            signingEscapePath?: boolean;
                                                                                                                                                                                                            streamCollector?: StreamCollector;
                                                                                                                                                                                                            streamHasher?: StreamHasher<Readable> | StreamHasher<Blob>;
                                                                                                                                                                                                            urlParser?: UrlParser;
                                                                                                                                                                                                            useArnRegion?: boolean | Provider<boolean>;
                                                                                                                                                                                                            useDualstackEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                            useFipsEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                            utf8Decoder?: Decoder;
                                                                                                                                                                                                            utf8Encoder?: Encoder;
                                                                                                                                                                                                        }

                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                        Index

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        apiVersion? +ClientDefaults | ts-lambda-api - v2.5.3
                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                          Interface ClientDefaults

                                                                                                                                                                                                          interface ClientDefaults {
                                                                                                                                                                                                              apiVersion?: string;
                                                                                                                                                                                                              base64Decoder?: Decoder;
                                                                                                                                                                                                              base64Encoder?: Encoder;
                                                                                                                                                                                                              bodyLengthChecker?: BodyLengthCalculator;
                                                                                                                                                                                                              cacheMiddleware?: boolean;
                                                                                                                                                                                                              credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
                                                                                                                                                                                                              defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
                                                                                                                                                                                                              defaultUserAgentProvider?: Provider<UserAgent>;
                                                                                                                                                                                                              disableHostPrefix?: boolean;
                                                                                                                                                                                                              eventStreamSerdeProvider?: EventStreamSerdeProvider;
                                                                                                                                                                                                              extensions?: RuntimeExtension[];
                                                                                                                                                                                                              getAwsChunkedEncodingStream?: GetAwsChunkedEncodingStream;
                                                                                                                                                                                                              logger?: Logger;
                                                                                                                                                                                                              maxAttempts?: number | Provider<number>;
                                                                                                                                                                                                              md5?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                              profile?: string;
                                                                                                                                                                                                              protocol?: ClientProtocol<HttpRequest, HttpResponse>;
                                                                                                                                                                                                              region?: string | Provider<string>;
                                                                                                                                                                                                              requestHandler?: HttpHandlerUserInput;
                                                                                                                                                                                                              retryMode?: string | Provider<string>;
                                                                                                                                                                                                              runtime?: string;
                                                                                                                                                                                                              sdkStreamMixin?: SdkStreamMixinInjector;
                                                                                                                                                                                                              serviceId?: string;
                                                                                                                                                                                                              sha1?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                              sha256?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                              signingEscapePath?: boolean;
                                                                                                                                                                                                              streamCollector?: StreamCollector;
                                                                                                                                                                                                              streamHasher?: StreamHasher<Readable> | StreamHasher<Blob>;
                                                                                                                                                                                                              urlParser?: UrlParser;
                                                                                                                                                                                                              useArnRegion?: boolean | Provider<boolean>;
                                                                                                                                                                                                              useDualstackEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                              useFipsEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                              utf8Decoder?: Decoder;
                                                                                                                                                                                                              utf8Encoder?: Encoder;
                                                                                                                                                                                                          }

                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                          Index

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          apiVersion? base64Decoder? base64Encoder? bodyLengthChecker? diff --git a/docs/interfaces/_internal_.ClientProtocol.html b/docs/interfaces/_internal_.ClientProtocol.html index eebb24f0..e4a8d906 100644 --- a/docs/interfaces/_internal_.ClientProtocol.html +++ b/docs/interfaces/_internal_.ClientProtocol.html @@ -1,6 +1,6 @@ ClientProtocol | ts-lambda-api - v2.5.3
                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                            Interface ClientProtocol<Request, Response>Internal

                                                                                                                                                                                                            A client protocol defines how to convert a message (e.g. HTTP request/response) to and from a data object.

                                                                                                                                                                                                            use $ClientProtocol

                                                                                                                                                                                                            -
                                                                                                                                                                                                            interface ClientProtocol<Request, Response> {
                                                                                                                                                                                                                deserializeResponse<Output extends MetadataBearer>(
                                                                                                                                                                                                                    operationSchema: OperationSchema,
                                                                                                                                                                                                                    context: HandlerExecutionContext & SerdeFunctions,
                                                                                                                                                                                                                    response: Response,
                                                                                                                                                                                                                ): Promise<Output>;
                                                                                                                                                                                                                getPayloadCodec(): Codec<any, any>;
                                                                                                                                                                                                                getRequestType(): new (...args: any[]) => Request;
                                                                                                                                                                                                                getResponseType(): new (...args: any[]) => Response;
                                                                                                                                                                                                                getShapeId(): string;
                                                                                                                                                                                                                serializeRequest<Input extends object>(
                                                                                                                                                                                                                    operationSchema: OperationSchema,
                                                                                                                                                                                                                    input: Input,
                                                                                                                                                                                                                    context: HandlerExecutionContext & SerdeFunctions & EndpointBearer,
                                                                                                                                                                                                                ): Promise<Request>;
                                                                                                                                                                                                                setSerdeContext(serdeContext: SerdeFunctions): void;
                                                                                                                                                                                                                updateServiceEndpoint(request: Request, endpoint: EndpointV2): Request;
                                                                                                                                                                                                            }

                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                            • Request
                                                                                                                                                                                                            • Response

                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Methods

                                                                                                                                                                                                            deserializeResponse +
                                                                                                                                                                                                            interface ClientProtocol<Request, Response> {
                                                                                                                                                                                                                deserializeResponse<Output extends MetadataBearer>(
                                                                                                                                                                                                                    operationSchema: OperationSchema,
                                                                                                                                                                                                                    context: HandlerExecutionContext & SerdeFunctions,
                                                                                                                                                                                                                    response: Response,
                                                                                                                                                                                                                ): Promise<Output>;
                                                                                                                                                                                                                getPayloadCodec(): Codec<any, any>;
                                                                                                                                                                                                                getRequestType(): new (...args: any[]) => Request;
                                                                                                                                                                                                                getResponseType(): new (...args: any[]) => Response;
                                                                                                                                                                                                                getShapeId(): string;
                                                                                                                                                                                                                serializeRequest<Input extends object>(
                                                                                                                                                                                                                    operationSchema: OperationSchema,
                                                                                                                                                                                                                    input: Input,
                                                                                                                                                                                                                    context: HandlerExecutionContext & SerdeFunctions & EndpointBearer,
                                                                                                                                                                                                                ): Promise<Request>;
                                                                                                                                                                                                                setSerdeContext(serdeContext: SerdeFunctions): void;
                                                                                                                                                                                                                updateServiceEndpoint(request: Request, endpoint: EndpointV2): Request;
                                                                                                                                                                                                            }

                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                            • Request
                                                                                                                                                                                                            • Response

                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Methods

                                                                                                                                                                                                            deserializeResponse getPayloadCodec getRequestType getResponseType diff --git a/docs/interfaces/_internal_.ClientRequestArgs.html b/docs/interfaces/_internal_.ClientRequestArgs.html index e66ff6fa..85555bb9 100644 --- a/docs/interfaces/_internal_.ClientRequestArgs.html +++ b/docs/interfaces/_internal_.ClientRequestArgs.html @@ -1,5 +1,5 @@ ClientRequestArgs | ts-lambda-api - v2.5.3
                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                              Interface ClientRequestArgs

                                                                                                                                                                                                              From T, pick a set of properties whose keys are in the union K

                                                                                                                                                                                                              -
                                                                                                                                                                                                              interface ClientRequestArgs {
                                                                                                                                                                                                                  _defaultAgent?: Agent;
                                                                                                                                                                                                                  agent?: boolean | Agent;
                                                                                                                                                                                                                  auth?: string;
                                                                                                                                                                                                                  createConnection?: (
                                                                                                                                                                                                                      options: ClientRequestArgs,
                                                                                                                                                                                                                      oncreate: (err: Error, socket: Duplex) => void,
                                                                                                                                                                                                                  ) => Duplex;
                                                                                                                                                                                                                  defaultPort?: string | number;
                                                                                                                                                                                                                  family?: number;
                                                                                                                                                                                                                  headers?: readonly string[] | OutgoingHttpHeaders;
                                                                                                                                                                                                                  hints?: number;
                                                                                                                                                                                                                  host?: string;
                                                                                                                                                                                                                  hostname?: string;
                                                                                                                                                                                                                  insecureHTTPParser?: boolean;
                                                                                                                                                                                                                  joinDuplicateHeaders?: boolean;
                                                                                                                                                                                                                  localAddress?: string;
                                                                                                                                                                                                                  localPort?: number;
                                                                                                                                                                                                                  lookup?: LookupFunction;
                                                                                                                                                                                                                  maxHeaderSize?: number;
                                                                                                                                                                                                                  method?: string;
                                                                                                                                                                                                                  path?: string;
                                                                                                                                                                                                                  port?: string | number;
                                                                                                                                                                                                                  protocol?: string;
                                                                                                                                                                                                                  setDefaultHeaders?: boolean;
                                                                                                                                                                                                                  setHost?: boolean;
                                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                                                  socketPath?: string;
                                                                                                                                                                                                                  timeout?: number;
                                                                                                                                                                                                                  uniqueHeaders?: (string | string[])[];
                                                                                                                                                                                                              }

                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                              Index

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              _defaultAgent? +
                                                                                                                                                                                                              interface ClientRequestArgs {
                                                                                                                                                                                                                  _defaultAgent?: Agent;
                                                                                                                                                                                                                  agent?: boolean | Agent;
                                                                                                                                                                                                                  auth?: string;
                                                                                                                                                                                                                  createConnection?: (
                                                                                                                                                                                                                      options: ClientRequestArgs,
                                                                                                                                                                                                                      oncreate: (err: Error, socket: Duplex) => void,
                                                                                                                                                                                                                  ) => Duplex;
                                                                                                                                                                                                                  defaultPort?: string | number;
                                                                                                                                                                                                                  family?: number;
                                                                                                                                                                                                                  headers?: readonly string[] | OutgoingHttpHeaders;
                                                                                                                                                                                                                  hints?: number;
                                                                                                                                                                                                                  host?: string;
                                                                                                                                                                                                                  hostname?: string;
                                                                                                                                                                                                                  insecureHTTPParser?: boolean;
                                                                                                                                                                                                                  joinDuplicateHeaders?: boolean;
                                                                                                                                                                                                                  localAddress?: string;
                                                                                                                                                                                                                  localPort?: number;
                                                                                                                                                                                                                  lookup?: LookupFunction;
                                                                                                                                                                                                                  maxHeaderSize?: number;
                                                                                                                                                                                                                  method?: string;
                                                                                                                                                                                                                  path?: string;
                                                                                                                                                                                                                  port?: string | number;
                                                                                                                                                                                                                  protocol?: string;
                                                                                                                                                                                                                  setDefaultHeaders?: boolean;
                                                                                                                                                                                                                  setHost?: boolean;
                                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                                                  socketPath?: string;
                                                                                                                                                                                                                  timeout?: number;
                                                                                                                                                                                                                  uniqueHeaders?: (string | string[])[];
                                                                                                                                                                                                              }

                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                              Index

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              _defaultAgent? agent? auth? createConnection? diff --git a/docs/interfaces/_internal_.Codec.html b/docs/interfaces/_internal_.Codec.html index 02e6ff52..d2e8c6a0 100644 --- a/docs/interfaces/_internal_.Codec.html +++ b/docs/interfaces/_internal_.Codec.html @@ -1,6 +1,6 @@ Codec | ts-lambda-api - v2.5.3
                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Interface Codec<S, D>Internal

                                                                                                                                                                                                                A codec creates serializers and deserializers for some format such as JSON, XML, or CBOR.

                                                                                                                                                                                                                use $Codec

                                                                                                                                                                                                                -
                                                                                                                                                                                                                interface Codec<S, D> {
                                                                                                                                                                                                                    createDeserializer(): ShapeDeserializer<D>;
                                                                                                                                                                                                                    createSerializer(): ShapeSerializer<S>;
                                                                                                                                                                                                                    setSerdeContext(serdeContext: SerdeFunctions): void;
                                                                                                                                                                                                                }

                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                • S
                                                                                                                                                                                                                • D

                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                createDeserializer +
                                                                                                                                                                                                                interface Codec<S, D> {
                                                                                                                                                                                                                    createDeserializer(): ShapeDeserializer<D>;
                                                                                                                                                                                                                    createSerializer(): ShapeSerializer<S>;
                                                                                                                                                                                                                    setSerdeContext(serdeContext: SerdeFunctions): void;
                                                                                                                                                                                                                }

                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                • S
                                                                                                                                                                                                                • D

                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                createDeserializer createSerializer setSerdeContext

                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.CollectionTag.html b/docs/interfaces/_internal_.CollectionTag.html index 02548f2a..547b2935 100644 --- a/docs/interfaces/_internal_.CollectionTag.html +++ b/docs/interfaces/_internal_.CollectionTag.html @@ -1,4 +1,4 @@ -CollectionTag | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                  Interface CollectionTag

                                                                                                                                                                                                                  interface CollectionTag {
                                                                                                                                                                                                                      collection: "map" | "seq";
                                                                                                                                                                                                                      createNode?: (
                                                                                                                                                                                                                          schema: Schema,
                                                                                                                                                                                                                          value: unknown,
                                                                                                                                                                                                                          ctx: CreateNodeContext,
                                                                                                                                                                                                                      ) => Node;
                                                                                                                                                                                                                      default?: boolean | "key";
                                                                                                                                                                                                                      format?: string;
                                                                                                                                                                                                                      identify?: (value: unknown) => boolean;
                                                                                                                                                                                                                      nodeClass?: {
                                                                                                                                                                                                                          from?: (schema: Schema, obj: unknown, ctx: CreateNodeContext) => Node;
                                                                                                                                                                                                                          new (schema?: Schema): Node;
                                                                                                                                                                                                                      };
                                                                                                                                                                                                                      resolve?: (
                                                                                                                                                                                                                          value: Parsed<ParsedNode, ParsedNode> | Parsed<ParsedNode>,
                                                                                                                                                                                                                          onError: (message: string) => void,
                                                                                                                                                                                                                          options: ParseOptions,
                                                                                                                                                                                                                      ) => unknown;
                                                                                                                                                                                                                      stringify?: never;
                                                                                                                                                                                                                      tag: string;
                                                                                                                                                                                                                      test?: never;
                                                                                                                                                                                                                  }

                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  collection +CollectionTag | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                    Interface CollectionTag

                                                                                                                                                                                                                    interface CollectionTag {
                                                                                                                                                                                                                        collection: "map" | "seq";
                                                                                                                                                                                                                        createNode?: (
                                                                                                                                                                                                                            schema: Schema,
                                                                                                                                                                                                                            value: unknown,
                                                                                                                                                                                                                            ctx: CreateNodeContext,
                                                                                                                                                                                                                        ) => Node;
                                                                                                                                                                                                                        default?: boolean | "key";
                                                                                                                                                                                                                        format?: string;
                                                                                                                                                                                                                        identify?: (value: unknown) => boolean;
                                                                                                                                                                                                                        nodeClass?: {
                                                                                                                                                                                                                            from?: (schema: Schema, obj: unknown, ctx: CreateNodeContext) => Node;
                                                                                                                                                                                                                            new (schema?: Schema): Node;
                                                                                                                                                                                                                        };
                                                                                                                                                                                                                        resolve?: (
                                                                                                                                                                                                                            value: Parsed<ParsedNode, ParsedNode> | Parsed<ParsedNode>,
                                                                                                                                                                                                                            onError: (message: string) => void,
                                                                                                                                                                                                                            options: ParseOptions,
                                                                                                                                                                                                                        ) => unknown;
                                                                                                                                                                                                                        stringify?: never;
                                                                                                                                                                                                                        tag: string;
                                                                                                                                                                                                                        test?: never;
                                                                                                                                                                                                                    }

                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    collection createNode? default? format? diff --git a/docs/interfaces/_internal_.CommonConnectionOptions.html b/docs/interfaces/_internal_.CommonConnectionOptions.html index f8a6ecf5..5a942416 100644 --- a/docs/interfaces/_internal_.CommonConnectionOptions.html +++ b/docs/interfaces/_internal_.CommonConnectionOptions.html @@ -1,4 +1,4 @@ -CommonConnectionOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                      Interface CommonConnectionOptions

                                                                                                                                                                                                                      interface CommonConnectionOptions {
                                                                                                                                                                                                                          ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>;
                                                                                                                                                                                                                          enableTrace?: boolean;
                                                                                                                                                                                                                          rejectUnauthorized?: boolean;
                                                                                                                                                                                                                          requestCert?: boolean;
                                                                                                                                                                                                                          secureContext?: SecureContext;
                                                                                                                                                                                                                          SNICallback?: (
                                                                                                                                                                                                                              servername: string,
                                                                                                                                                                                                                              cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                          ) => void;
                                                                                                                                                                                                                      }

                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      ALPNProtocols? +CommonConnectionOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                        Interface CommonConnectionOptions

                                                                                                                                                                                                                        interface CommonConnectionOptions {
                                                                                                                                                                                                                            ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>;
                                                                                                                                                                                                                            enableTrace?: boolean;
                                                                                                                                                                                                                            rejectUnauthorized?: boolean;
                                                                                                                                                                                                                            requestCert?: boolean;
                                                                                                                                                                                                                            secureContext?: SecureContext;
                                                                                                                                                                                                                            SNICallback?: (
                                                                                                                                                                                                                                servername: string,
                                                                                                                                                                                                                                cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                            ) => void;
                                                                                                                                                                                                                        }

                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        ALPNProtocols? enableTrace? rejectUnauthorized? requestCert? diff --git a/docs/interfaces/_internal_.ComponentsObject.html b/docs/interfaces/_internal_.ComponentsObject.html index c949a0b9..9304eec5 100644 --- a/docs/interfaces/_internal_.ComponentsObject.html +++ b/docs/interfaces/_internal_.ComponentsObject.html @@ -1,4 +1,4 @@ -ComponentsObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                          Interface ComponentsObject

                                                                                                                                                                                                                          interface ComponentsObject {
                                                                                                                                                                                                                              callbacks?: { [callback: string]: ReferenceObject | CallbackObject };
                                                                                                                                                                                                                              examples?: { [example: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                                                                              headers?: { [header: string]: ReferenceObject | HeaderObject };
                                                                                                                                                                                                                              links?: { [link: string]: ReferenceObject | LinkObject };
                                                                                                                                                                                                                              parameters?: { [parameter: string]: ReferenceObject | ParameterObject };
                                                                                                                                                                                                                              pathItems?: { [pathItem: string]: ReferenceObject | PathItemObject };
                                                                                                                                                                                                                              requestBodies?: { [request: string]: ReferenceObject | RequestBodyObject };
                                                                                                                                                                                                                              responses?: { [response: string]: ReferenceObject | ResponseObject };
                                                                                                                                                                                                                              schemas?: { [schema: string]: SchemaObject | ReferenceObject };
                                                                                                                                                                                                                              securitySchemes?: {
                                                                                                                                                                                                                                  [securityScheme: string]: ReferenceObject | SecuritySchemeObject;
                                                                                                                                                                                                                              };
                                                                                                                                                                                                                              [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                          }

                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                          • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          callbacks? +ComponentsObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                            Interface ComponentsObject

                                                                                                                                                                                                                            interface ComponentsObject {
                                                                                                                                                                                                                                callbacks?: { [callback: string]: ReferenceObject | CallbackObject };
                                                                                                                                                                                                                                examples?: { [example: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                                                                                headers?: { [header: string]: ReferenceObject | HeaderObject };
                                                                                                                                                                                                                                links?: { [link: string]: ReferenceObject | LinkObject };
                                                                                                                                                                                                                                parameters?: { [parameter: string]: ReferenceObject | ParameterObject };
                                                                                                                                                                                                                                pathItems?: { [pathItem: string]: ReferenceObject | PathItemObject };
                                                                                                                                                                                                                                requestBodies?: { [request: string]: ReferenceObject | RequestBodyObject };
                                                                                                                                                                                                                                responses?: { [response: string]: ReferenceObject | ResponseObject };
                                                                                                                                                                                                                                schemas?: { [schema: string]: SchemaObject | ReferenceObject };
                                                                                                                                                                                                                                securitySchemes?: {
                                                                                                                                                                                                                                    [securityScheme: string]: ReferenceObject | SecuritySchemeObject;
                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                            }

                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                            • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            callbacks? examples? headers? links? diff --git a/docs/interfaces/_internal_.ConfigurableSerdeContext.html b/docs/interfaces/_internal_.ConfigurableSerdeContext.html index d6475415..b0e23a13 100644 --- a/docs/interfaces/_internal_.ConfigurableSerdeContext.html +++ b/docs/interfaces/_internal_.ConfigurableSerdeContext.html @@ -1,4 +1,4 @@ ConfigurableSerdeContext | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                              Interface ConfigurableSerdeContext

                                                                                                                                                                                                                              Allows a protocol, codec, or serde utility to accept the serdeContext from a client configuration or request/response handlerExecutionContext.

                                                                                                                                                                                                                              -
                                                                                                                                                                                                                              interface ConfigurableSerdeContext {
                                                                                                                                                                                                                                  setSerdeContext(serdeContext: SerdeFunctions): void;
                                                                                                                                                                                                                              }

                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                              setSerdeContext +
                                                                                                                                                                                                                              interface ConfigurableSerdeContext {
                                                                                                                                                                                                                                  setSerdeContext(serdeContext: SerdeFunctions): void;
                                                                                                                                                                                                                              }

                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                              setSerdeContext

                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.ConnectionOptions.html b/docs/interfaces/_internal_.ConnectionOptions.html index fe4c0902..94b24cd9 100644 --- a/docs/interfaces/_internal_.ConnectionOptions.html +++ b/docs/interfaces/_internal_.ConnectionOptions.html @@ -1,4 +1,4 @@ -ConnectionOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                Interface ConnectionOptions

                                                                                                                                                                                                                                interface ConnectionOptions {
                                                                                                                                                                                                                                    allowPartialTrustChain?: boolean;
                                                                                                                                                                                                                                    ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                                                                                                                                                    ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>;
                                                                                                                                                                                                                                    ca?:
                                                                                                                                                                                                                                        | string
                                                                                                                                                                                                                                        | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                        | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                    cert?:
                                                                                                                                                                                                                                        | string
                                                                                                                                                                                                                                        | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                        | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                    checkServerIdentity?: (hostname: string, cert: PeerCertificate) => Error;
                                                                                                                                                                                                                                    ciphers?: string;
                                                                                                                                                                                                                                    clientCertEngine?: string;
                                                                                                                                                                                                                                    crl?:
                                                                                                                                                                                                                                        | string
                                                                                                                                                                                                                                        | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                        | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                    dhparam?: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                    ecdhCurve?: string;
                                                                                                                                                                                                                                    enableTrace?: boolean;
                                                                                                                                                                                                                                    honorCipherOrder?: boolean;
                                                                                                                                                                                                                                    host?: string;
                                                                                                                                                                                                                                    key?:
                                                                                                                                                                                                                                        | string
                                                                                                                                                                                                                                        | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                        | (string | Buffer<ArrayBufferLike> | KeyObject)[];
                                                                                                                                                                                                                                    lookup?: LookupFunction;
                                                                                                                                                                                                                                    maxVersion?: SecureVersion;
                                                                                                                                                                                                                                    minDHSize?: number;
                                                                                                                                                                                                                                    minVersion?: SecureVersion;
                                                                                                                                                                                                                                    passphrase?: string;
                                                                                                                                                                                                                                    path?: string;
                                                                                                                                                                                                                                    pfx?:
                                                                                                                                                                                                                                        | string
                                                                                                                                                                                                                                        | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                        | (string | Buffer<ArrayBufferLike> | PxfObject)[];
                                                                                                                                                                                                                                    port?: number;
                                                                                                                                                                                                                                    privateKeyEngine?: string;
                                                                                                                                                                                                                                    privateKeyIdentifier?: string;
                                                                                                                                                                                                                                    pskCallback?: (hint: string) => PSKCallbackNegotation;
                                                                                                                                                                                                                                    rejectUnauthorized?: boolean;
                                                                                                                                                                                                                                    requestCert?: boolean;
                                                                                                                                                                                                                                    secureContext?: SecureContext;
                                                                                                                                                                                                                                    secureOptions?: number;
                                                                                                                                                                                                                                    secureProtocol?: string;
                                                                                                                                                                                                                                    servername?: string;
                                                                                                                                                                                                                                    session?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                    sessionIdContext?: string;
                                                                                                                                                                                                                                    sessionTimeout?: number;
                                                                                                                                                                                                                                    sigalgs?: string;
                                                                                                                                                                                                                                    SNICallback?: (
                                                                                                                                                                                                                                        servername: string,
                                                                                                                                                                                                                                        cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                                    ) => void;
                                                                                                                                                                                                                                    socket?: Duplex;
                                                                                                                                                                                                                                    ticketKeys?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                    timeout?: number;
                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                allowPartialTrustChain? +ConnectionOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                  Interface ConnectionOptions

                                                                                                                                                                                                                                  interface ConnectionOptions {
                                                                                                                                                                                                                                      allowPartialTrustChain?: boolean;
                                                                                                                                                                                                                                      ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                                                                                                                                                      ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>;
                                                                                                                                                                                                                                      ca?:
                                                                                                                                                                                                                                          | string
                                                                                                                                                                                                                                          | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                          | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                      cert?:
                                                                                                                                                                                                                                          | string
                                                                                                                                                                                                                                          | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                          | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                      checkServerIdentity?: (hostname: string, cert: PeerCertificate) => Error;
                                                                                                                                                                                                                                      ciphers?: string;
                                                                                                                                                                                                                                      clientCertEngine?: string;
                                                                                                                                                                                                                                      crl?:
                                                                                                                                                                                                                                          | string
                                                                                                                                                                                                                                          | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                          | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                      dhparam?: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                      ecdhCurve?: string;
                                                                                                                                                                                                                                      enableTrace?: boolean;
                                                                                                                                                                                                                                      honorCipherOrder?: boolean;
                                                                                                                                                                                                                                      host?: string;
                                                                                                                                                                                                                                      key?:
                                                                                                                                                                                                                                          | string
                                                                                                                                                                                                                                          | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                          | (string | Buffer<ArrayBufferLike> | KeyObject)[];
                                                                                                                                                                                                                                      lookup?: LookupFunction;
                                                                                                                                                                                                                                      maxVersion?: SecureVersion;
                                                                                                                                                                                                                                      minDHSize?: number;
                                                                                                                                                                                                                                      minVersion?: SecureVersion;
                                                                                                                                                                                                                                      passphrase?: string;
                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                      pfx?:
                                                                                                                                                                                                                                          | string
                                                                                                                                                                                                                                          | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                          | (string | Buffer<ArrayBufferLike> | PxfObject)[];
                                                                                                                                                                                                                                      port?: number;
                                                                                                                                                                                                                                      privateKeyEngine?: string;
                                                                                                                                                                                                                                      privateKeyIdentifier?: string;
                                                                                                                                                                                                                                      pskCallback?: (hint: string) => PSKCallbackNegotation;
                                                                                                                                                                                                                                      rejectUnauthorized?: boolean;
                                                                                                                                                                                                                                      requestCert?: boolean;
                                                                                                                                                                                                                                      secureContext?: SecureContext;
                                                                                                                                                                                                                                      secureOptions?: number;
                                                                                                                                                                                                                                      secureProtocol?: string;
                                                                                                                                                                                                                                      servername?: string;
                                                                                                                                                                                                                                      session?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                      sessionIdContext?: string;
                                                                                                                                                                                                                                      sessionTimeout?: number;
                                                                                                                                                                                                                                      sigalgs?: string;
                                                                                                                                                                                                                                      SNICallback?: (
                                                                                                                                                                                                                                          servername: string,
                                                                                                                                                                                                                                          cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                                      ) => void;
                                                                                                                                                                                                                                      socket?: Duplex;
                                                                                                                                                                                                                                      ticketKeys?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                      timeout?: number;
                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  allowPartialTrustChain? ALPNCallback? ALPNProtocols? ca? diff --git a/docs/interfaces/_internal_.ContactObject.html b/docs/interfaces/_internal_.ContactObject.html index 117ab4c2..e35f1e8f 100644 --- a/docs/interfaces/_internal_.ContactObject.html +++ b/docs/interfaces/_internal_.ContactObject.html @@ -1,4 +1,4 @@ -ContactObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                    Interface ContactObject

                                                                                                                                                                                                                                    interface ContactObject {
                                                                                                                                                                                                                                        email?: string;
                                                                                                                                                                                                                                        name?: string;
                                                                                                                                                                                                                                        url?: string;
                                                                                                                                                                                                                                        [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                    • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    email? +ContactObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                      Interface ContactObject

                                                                                                                                                                                                                                      interface ContactObject {
                                                                                                                                                                                                                                          email?: string;
                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                          url?: string;
                                                                                                                                                                                                                                          [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                      • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      email? name? url?

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      email?: string
                                                                                                                                                                                                                                      name?: string
                                                                                                                                                                                                                                      url?: string

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.Context.html b/docs/interfaces/_internal_.Context.html index abc3faa8..6375b398 100644 --- a/docs/interfaces/_internal_.Context.html +++ b/docs/interfaces/_internal_.Context.html @@ -1,4 +1,4 @@ -Context | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                        Interface Context

                                                                                                                                                                                                                                        Handler context parameter. +Context | ts-lambda-api - v2.5.3

                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                          Interface Context

                                                                                                                                                                                                                                          Handler context parameter. See AWS documentation.

                                                                                                                                                                                                                                          interface Context {
                                                                                                                                                                                                                                              awsRequestId: string;
                                                                                                                                                                                                                                              callbackWaitsForEmptyEventLoop: boolean;
                                                                                                                                                                                                                                              clientContext?: ClientContext;
                                                                                                                                                                                                                                              functionName: string;
                                                                                                                                                                                                                                              functionVersion: string;
                                                                                                                                                                                                                                              identity?: CognitoIdentity;
                                                                                                                                                                                                                                              invokedFunctionArn: string;
                                                                                                                                                                                                                                              logGroupName: string;
                                                                                                                                                                                                                                              logStreamName: string;
                                                                                                                                                                                                                                              memoryLimitInMB: string;
                                                                                                                                                                                                                                              tenantId?: string;
                                                                                                                                                                                                                                              done(error?: Error, result?: any): void;
                                                                                                                                                                                                                                              fail(error: string | Error): void;
                                                                                                                                                                                                                                              getRemainingTimeInMillis(): number;
                                                                                                                                                                                                                                              succeed(messageOrObject: any): void;
                                                                                                                                                                                                                                              succeed(message: string, object: any): void;
                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                          awsRequestId callbackWaitsForEmptyEventLoop diff --git a/docs/interfaces/_internal_.CopyOperation.html b/docs/interfaces/_internal_.CopyOperation.html index fc3f8965..ec904f06 100644 --- a/docs/interfaces/_internal_.CopyOperation.html +++ b/docs/interfaces/_internal_.CopyOperation.html @@ -1,4 +1,4 @@ -CopyOperation | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                            Interface CopyOperation

                                                                                                                                                                                                                                            interface CopyOperation {
                                                                                                                                                                                                                                                from: string;
                                                                                                                                                                                                                                                op: "copy";
                                                                                                                                                                                                                                                path: string;
                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                            from +CopyOperation | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                              Interface CopyOperation

                                                                                                                                                                                                                                              interface CopyOperation {
                                                                                                                                                                                                                                                  from: string;
                                                                                                                                                                                                                                                  op: "copy";
                                                                                                                                                                                                                                                  path: string;
                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              from op path

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              from: string
                                                                                                                                                                                                                                              op: "copy"
                                                                                                                                                                                                                                              path: string

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.DefaultExtensionConfiguration.html b/docs/interfaces/_internal_.DefaultExtensionConfiguration.html index eda6021f..17ff29c1 100644 --- a/docs/interfaces/_internal_.DefaultExtensionConfiguration.html +++ b/docs/interfaces/_internal_.DefaultExtensionConfiguration.html @@ -1,5 +1,5 @@ DefaultExtensionConfiguration | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                Interface DefaultExtensionConfigurationInternal

                                                                                                                                                                                                                                                Default extension configuration consisting various configurations for modifying a service client

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                interface DefaultExtensionConfiguration {
                                                                                                                                                                                                                                                    addChecksumAlgorithm(algo: ChecksumAlgorithm): void;
                                                                                                                                                                                                                                                    checksumAlgorithms(): ChecksumAlgorithm[];
                                                                                                                                                                                                                                                    retryStrategy(): Provider<RetryStrategy | RetryStrategyV2>;
                                                                                                                                                                                                                                                    setRetryStrategy(
                                                                                                                                                                                                                                                        retryStrategy: Provider<RetryStrategy | RetryStrategyV2>,
                                                                                                                                                                                                                                                    ): void;
                                                                                                                                                                                                                                                    [key: string]: any;
                                                                                                                                                                                                                                                    [key: number]: any;
                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                • [key: string]: any
                                                                                                                                                                                                                                                • [key: number]: any
                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                addChecksumAlgorithm +
                                                                                                                                                                                                                                                interface DefaultExtensionConfiguration {
                                                                                                                                                                                                                                                    addChecksumAlgorithm(algo: ChecksumAlgorithm): void;
                                                                                                                                                                                                                                                    checksumAlgorithms(): ChecksumAlgorithm[];
                                                                                                                                                                                                                                                    retryStrategy(): Provider<RetryStrategy | RetryStrategyV2>;
                                                                                                                                                                                                                                                    setRetryStrategy(
                                                                                                                                                                                                                                                        retryStrategy: Provider<RetryStrategy | RetryStrategyV2>,
                                                                                                                                                                                                                                                    ): void;
                                                                                                                                                                                                                                                    [key: string]: any;
                                                                                                                                                                                                                                                    [key: number]: any;
                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                • [key: string]: any
                                                                                                                                                                                                                                                • [key: number]: any
                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                addChecksumAlgorithm checksumAlgorithms retryStrategy setRetryStrategy diff --git a/docs/interfaces/_internal_.DeserializeHandlerOutput.html b/docs/interfaces/_internal_.DeserializeHandlerOutput.html index 1cd7c80d..bc953d26 100644 --- a/docs/interfaces/_internal_.DeserializeHandlerOutput.html +++ b/docs/interfaces/_internal_.DeserializeHandlerOutput.html @@ -1,4 +1,4 @@ -DeserializeHandlerOutput | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                  Interface DeserializeHandlerOutput<Output>

                                                                                                                                                                                                                                                  interface DeserializeHandlerOutput<Output extends object> {
                                                                                                                                                                                                                                                      output?: Output;
                                                                                                                                                                                                                                                      response: unknown;
                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                  • Output extends object

                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                  output? +DeserializeHandlerOutput | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Interface DeserializeHandlerOutput<Output>

                                                                                                                                                                                                                                                    interface DeserializeHandlerOutput<Output extends object> {
                                                                                                                                                                                                                                                        output?: Output;
                                                                                                                                                                                                                                                        response: unknown;
                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                    • Output extends object

                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                    output? response

                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                    output?: Output
                                                                                                                                                                                                                                                    response: unknown

                                                                                                                                                                                                                                                    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 diff --git a/docs/interfaces/_internal_.DetailedPeerCertificate.html b/docs/interfaces/_internal_.DetailedPeerCertificate.html index b7335ba0..aab5110c 100644 --- a/docs/interfaces/_internal_.DetailedPeerCertificate.html +++ b/docs/interfaces/_internal_.DetailedPeerCertificate.html @@ -1,4 +1,4 @@ -DetailedPeerCertificate | ts-lambda-api - v2.5.3

                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                      Interface DetailedPeerCertificate

                                                                                                                                                                                                                                                      interface DetailedPeerCertificate {
                                                                                                                                                                                                                                                          asn1Curve?: string;
                                                                                                                                                                                                                                                          bits?: number;
                                                                                                                                                                                                                                                          ca: boolean;
                                                                                                                                                                                                                                                          exponent?: string;
                                                                                                                                                                                                                                                          ext_key_usage?: string[];
                                                                                                                                                                                                                                                          fingerprint: string;
                                                                                                                                                                                                                                                          fingerprint256: string;
                                                                                                                                                                                                                                                          fingerprint512: string;
                                                                                                                                                                                                                                                          infoAccess?: Dict<string[]>;
                                                                                                                                                                                                                                                          issuer: Certificate;
                                                                                                                                                                                                                                                          issuerCertificate: DetailedPeerCertificate;
                                                                                                                                                                                                                                                          modulus?: string;
                                                                                                                                                                                                                                                          nistCurve?: string;
                                                                                                                                                                                                                                                          pubkey?: NonSharedBuffer;
                                                                                                                                                                                                                                                          raw: NonSharedBuffer;
                                                                                                                                                                                                                                                          serialNumber: string;
                                                                                                                                                                                                                                                          subject: Certificate;
                                                                                                                                                                                                                                                          subjectaltname?: string;
                                                                                                                                                                                                                                                          valid_from: string;
                                                                                                                                                                                                                                                          valid_to: string;
                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                      asn1Curve? +DetailedPeerCertificate | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                        Interface DetailedPeerCertificate

                                                                                                                                                                                                                                                        interface DetailedPeerCertificate {
                                                                                                                                                                                                                                                            asn1Curve?: string;
                                                                                                                                                                                                                                                            bits?: number;
                                                                                                                                                                                                                                                            ca: boolean;
                                                                                                                                                                                                                                                            exponent?: string;
                                                                                                                                                                                                                                                            ext_key_usage?: string[];
                                                                                                                                                                                                                                                            fingerprint: string;
                                                                                                                                                                                                                                                            fingerprint256: string;
                                                                                                                                                                                                                                                            fingerprint512: string;
                                                                                                                                                                                                                                                            infoAccess?: Dict<string[]>;
                                                                                                                                                                                                                                                            issuer: Certificate;
                                                                                                                                                                                                                                                            issuerCertificate: DetailedPeerCertificate;
                                                                                                                                                                                                                                                            modulus?: string;
                                                                                                                                                                                                                                                            nistCurve?: string;
                                                                                                                                                                                                                                                            pubkey?: NonSharedBuffer;
                                                                                                                                                                                                                                                            raw: NonSharedBuffer;
                                                                                                                                                                                                                                                            serialNumber: string;
                                                                                                                                                                                                                                                            subject: Certificate;
                                                                                                                                                                                                                                                            subjectaltname?: string;
                                                                                                                                                                                                                                                            valid_from: string;
                                                                                                                                                                                                                                                            valid_to: string;
                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                        asn1Curve? bits? ca exponent? diff --git a/docs/interfaces/_internal_.Dict.html b/docs/interfaces/_internal_.Dict.html index c5d32a8b..62141b9e 100644 --- a/docs/interfaces/_internal_.Dict.html +++ b/docs/interfaces/_internal_.Dict.html @@ -1 +1 @@ -Dict | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                          Interface Dict<T>

                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                          • T

                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                          • [key: string]: T

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                          +Dict | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                            Interface Dict<T>

                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                            • [key: string]: T

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.Document.Parsed.html b/docs/interfaces/_internal_.Document.Parsed.html index bfbe2ae3..f00b7598 100644 --- a/docs/interfaces/_internal_.Document.Parsed.html +++ b/docs/interfaces/_internal_.Document.Parsed.html @@ -1,5 +1,5 @@ Parsed | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                              Interface Parsed<Contents, Strict>

                                                                                                                                                                                                                                                              The typing of directives fails in TS <= 4.2

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              interface Parsed<
                                                                                                                                                                                                                                                                  Contents extends ParsedNode = ParsedNode,
                                                                                                                                                                                                                                                                  Strict extends boolean = true,
                                                                                                                                                                                                                                                              > {
                                                                                                                                                                                                                                                                  "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                  comment: string;
                                                                                                                                                                                                                                                                  commentBefore: string;
                                                                                                                                                                                                                                                                  contents: Strict extends true ? Contents : Contents;
                                                                                                                                                                                                                                                                  directives: Directives;
                                                                                                                                                                                                                                                                  errors: YAMLError[];
                                                                                                                                                                                                                                                                  options: Required<
                                                                                                                                                                                                                                                                      Omit<
                                                                                                                                                                                                                                                                          ParseOptions & DocumentOptions,
                                                                                                                                                                                                                                                                          "_directives"
                                                                                                                                                                                                                                                                          | "lineCounter"
                                                                                                                                                                                                                                                                          | "version",
                                                                                                                                                                                                                                                                      >,
                                                                                                                                                                                                                                                                  >;
                                                                                                                                                                                                                                                                  range: Range;
                                                                                                                                                                                                                                                                  schema: Schema;
                                                                                                                                                                                                                                                                  warnings: YAMLWarning[];
                                                                                                                                                                                                                                                                  add(value: any): void;
                                                                                                                                                                                                                                                                  addIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                  clone(): Document<Contents, Strict>;
                                                                                                                                                                                                                                                                  createAlias(
                                                                                                                                                                                                                                                                      node: Strict extends true
                                                                                                                                                                                                                                                                          ? Scalar<unknown>
                                                                                                                                                                                                                                                                          | YAMLMap<unknown, unknown>
                                                                                                                                                                                                                                                                          | YAMLSeq<unknown>
                                                                                                                                                                                                                                                                          : Node,
                                                                                                                                                                                                                                                                      name?: string,
                                                                                                                                                                                                                                                                  ): Alias;
                                                                                                                                                                                                                                                                  createNode<T = unknown>(value: T, options?: CreateNodeOptions): NodeType<T>;
                                                                                                                                                                                                                                                                  createNode<T = unknown>(
                                                                                                                                                                                                                                                                      value: T,
                                                                                                                                                                                                                                                                      replacer: Replacer | CreateNodeOptions,
                                                                                                                                                                                                                                                                      options?: CreateNodeOptions,
                                                                                                                                                                                                                                                                  ): NodeType<T>;
                                                                                                                                                                                                                                                                  createPair<K extends Node = Node, V extends Node = Node>(
                                                                                                                                                                                                                                                                      key: unknown,
                                                                                                                                                                                                                                                                      value: unknown,
                                                                                                                                                                                                                                                                      options?: CreateNodeOptions,
                                                                                                                                                                                                                                                                  ): Pair<K, V>;
                                                                                                                                                                                                                                                                  delete(key: unknown): boolean;
                                                                                                                                                                                                                                                                  deleteIn(path: Iterable<unknown, any, any>): boolean;
                                                                                                                                                                                                                                                                  get(
                                                                                                                                                                                                                                                                      key: unknown,
                                                                                                                                                                                                                                                                      keepScalar?: boolean,
                                                                                                                                                                                                                                                                  ): Strict extends true ? unknown : any;
                                                                                                                                                                                                                                                                  getIn(
                                                                                                                                                                                                                                                                      path: Iterable<unknown, any, any>,
                                                                                                                                                                                                                                                                      keepScalar?: boolean,
                                                                                                                                                                                                                                                                  ): Strict extends true ? unknown : any;
                                                                                                                                                                                                                                                                  has(key: unknown): boolean;
                                                                                                                                                                                                                                                                  hasIn(path: Iterable<unknown, any, any>): boolean;
                                                                                                                                                                                                                                                                  set(key: any, value: unknown): void;
                                                                                                                                                                                                                                                                  setIn(path: Iterable<unknown, any, any>, value: unknown): void;
                                                                                                                                                                                                                                                                  setSchema(version: "1.1" | "1.2" | "next", options?: SchemaOptions): void;
                                                                                                                                                                                                                                                                  toJS(opt?: ToJSOptions & { [ignored: string]: unknown }): any;
                                                                                                                                                                                                                                                                  toJSON(
                                                                                                                                                                                                                                                                      jsonArg?: string,
                                                                                                                                                                                                                                                                      onAnchor?: (value: unknown, count: number) => void,
                                                                                                                                                                                                                                                                  ): any;
                                                                                                                                                                                                                                                                  toString(options?: ToStringOptions): string;
                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              [NODE_TYPE] +
                                                                                                                                                                                                                                                              interface Parsed<
                                                                                                                                                                                                                                                                  Contents extends ParsedNode = ParsedNode,
                                                                                                                                                                                                                                                                  Strict extends boolean = true,
                                                                                                                                                                                                                                                              > {
                                                                                                                                                                                                                                                                  "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                  comment: string;
                                                                                                                                                                                                                                                                  commentBefore: string;
                                                                                                                                                                                                                                                                  contents: Strict extends true ? Contents : Contents;
                                                                                                                                                                                                                                                                  directives: Directives;
                                                                                                                                                                                                                                                                  errors: YAMLError[];
                                                                                                                                                                                                                                                                  options: Required<
                                                                                                                                                                                                                                                                      Omit<
                                                                                                                                                                                                                                                                          ParseOptions & DocumentOptions,
                                                                                                                                                                                                                                                                          "_directives"
                                                                                                                                                                                                                                                                          | "lineCounter"
                                                                                                                                                                                                                                                                          | "version",
                                                                                                                                                                                                                                                                      >,
                                                                                                                                                                                                                                                                  >;
                                                                                                                                                                                                                                                                  range: Range;
                                                                                                                                                                                                                                                                  schema: Schema;
                                                                                                                                                                                                                                                                  warnings: YAMLWarning[];
                                                                                                                                                                                                                                                                  add(value: any): void;
                                                                                                                                                                                                                                                                  addIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                  clone(): Document<Contents, Strict>;
                                                                                                                                                                                                                                                                  createAlias(
                                                                                                                                                                                                                                                                      node: Strict extends true
                                                                                                                                                                                                                                                                          ? Scalar<unknown>
                                                                                                                                                                                                                                                                          | YAMLMap<unknown, unknown>
                                                                                                                                                                                                                                                                          | YAMLSeq<unknown>
                                                                                                                                                                                                                                                                          : Node,
                                                                                                                                                                                                                                                                      name?: string,
                                                                                                                                                                                                                                                                  ): Alias;
                                                                                                                                                                                                                                                                  createNode<T = unknown>(value: T, options?: CreateNodeOptions): NodeType<T>;
                                                                                                                                                                                                                                                                  createNode<T = unknown>(
                                                                                                                                                                                                                                                                      value: T,
                                                                                                                                                                                                                                                                      replacer: Replacer | CreateNodeOptions,
                                                                                                                                                                                                                                                                      options?: CreateNodeOptions,
                                                                                                                                                                                                                                                                  ): NodeType<T>;
                                                                                                                                                                                                                                                                  createPair<K extends Node = Node, V extends Node = Node>(
                                                                                                                                                                                                                                                                      key: unknown,
                                                                                                                                                                                                                                                                      value: unknown,
                                                                                                                                                                                                                                                                      options?: CreateNodeOptions,
                                                                                                                                                                                                                                                                  ): Pair<K, V>;
                                                                                                                                                                                                                                                                  delete(key: unknown): boolean;
                                                                                                                                                                                                                                                                  deleteIn(path: Iterable<unknown, any, any>): boolean;
                                                                                                                                                                                                                                                                  get(
                                                                                                                                                                                                                                                                      key: unknown,
                                                                                                                                                                                                                                                                      keepScalar?: boolean,
                                                                                                                                                                                                                                                                  ): Strict extends true ? unknown : any;
                                                                                                                                                                                                                                                                  getIn(
                                                                                                                                                                                                                                                                      path: Iterable<unknown, any, any>,
                                                                                                                                                                                                                                                                      keepScalar?: boolean,
                                                                                                                                                                                                                                                                  ): Strict extends true ? unknown : any;
                                                                                                                                                                                                                                                                  has(key: unknown): boolean;
                                                                                                                                                                                                                                                                  hasIn(path: Iterable<unknown, any, any>): boolean;
                                                                                                                                                                                                                                                                  set(key: any, value: unknown): void;
                                                                                                                                                                                                                                                                  setIn(path: Iterable<unknown, any, any>, value: unknown): void;
                                                                                                                                                                                                                                                                  setSchema(version: "1.1" | "1.2" | "next", options?: SchemaOptions): void;
                                                                                                                                                                                                                                                                  toJS(opt?: ToJSOptions & { [ignored: string]: unknown }): any;
                                                                                                                                                                                                                                                                  toJSON(
                                                                                                                                                                                                                                                                      jsonArg?: string,
                                                                                                                                                                                                                                                                      onAnchor?: (value: unknown, count: number) => void,
                                                                                                                                                                                                                                                                  ): any;
                                                                                                                                                                                                                                                                  toString(options?: ToStringOptions): string;
                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              [NODE_TYPE] comment commentBefore contents diff --git a/docs/interfaces/_internal_.EncodingObject.html b/docs/interfaces/_internal_.EncodingObject.html index 85227c6a..9bac7fc8 100644 --- a/docs/interfaces/_internal_.EncodingObject.html +++ b/docs/interfaces/_internal_.EncodingObject.html @@ -1 +1 @@ -EncodingObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                Interface EncodingObject

                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                • [property: string]: any
                                                                                                                                                                                                                                                                • [extensionName: `x-${string}`]: any

                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                +EncodingObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                  Interface EncodingObject

                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                  • [property: string]: any
                                                                                                                                                                                                                                                                  • [extensionName: `x-${string}`]: any

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.EndpointParameters.html b/docs/interfaces/_internal_.EndpointParameters.html index 265a55d6..3e501e6d 100644 --- a/docs/interfaces/_internal_.EndpointParameters.html +++ b/docs/interfaces/_internal_.EndpointParameters.html @@ -1,4 +1,4 @@ -EndpointParameters | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                    Interface EndpointParameters

                                                                                                                                                                                                                                                                    interface EndpointParameters {
                                                                                                                                                                                                                                                                        Accelerate?: boolean;
                                                                                                                                                                                                                                                                        Bucket?: string;
                                                                                                                                                                                                                                                                        CopySource?: string;
                                                                                                                                                                                                                                                                        DisableAccessPoints?: boolean;
                                                                                                                                                                                                                                                                        DisableMultiRegionAccessPoints?: boolean;
                                                                                                                                                                                                                                                                        DisableS3ExpressSessionAuth?: boolean;
                                                                                                                                                                                                                                                                        Endpoint?: string;
                                                                                                                                                                                                                                                                        ForcePathStyle?: boolean;
                                                                                                                                                                                                                                                                        Key?: string;
                                                                                                                                                                                                                                                                        Prefix?: string;
                                                                                                                                                                                                                                                                        Region?: string;
                                                                                                                                                                                                                                                                        UseArnRegion?: boolean;
                                                                                                                                                                                                                                                                        UseDualStack?: boolean;
                                                                                                                                                                                                                                                                        UseFIPS?: boolean;
                                                                                                                                                                                                                                                                        UseGlobalEndpoint?: boolean;
                                                                                                                                                                                                                                                                        UseObjectLambdaEndpoint?: boolean;
                                                                                                                                                                                                                                                                        UseS3ExpressControlEndpoint?: boolean;
                                                                                                                                                                                                                                                                        [name: string]: string | boolean | string[];
                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                    • [name: string]: string | boolean | string[]
                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                    Accelerate? +EndpointParameters | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                      Interface EndpointParameters

                                                                                                                                                                                                                                                                      interface EndpointParameters {
                                                                                                                                                                                                                                                                          Accelerate?: boolean;
                                                                                                                                                                                                                                                                          Bucket?: string;
                                                                                                                                                                                                                                                                          CopySource?: string;
                                                                                                                                                                                                                                                                          DisableAccessPoints?: boolean;
                                                                                                                                                                                                                                                                          DisableMultiRegionAccessPoints?: boolean;
                                                                                                                                                                                                                                                                          DisableS3ExpressSessionAuth?: boolean;
                                                                                                                                                                                                                                                                          Endpoint?: string;
                                                                                                                                                                                                                                                                          ForcePathStyle?: boolean;
                                                                                                                                                                                                                                                                          Key?: string;
                                                                                                                                                                                                                                                                          Prefix?: string;
                                                                                                                                                                                                                                                                          Region?: string;
                                                                                                                                                                                                                                                                          UseArnRegion?: boolean;
                                                                                                                                                                                                                                                                          UseDualStack?: boolean;
                                                                                                                                                                                                                                                                          UseFIPS?: boolean;
                                                                                                                                                                                                                                                                          UseGlobalEndpoint?: boolean;
                                                                                                                                                                                                                                                                          UseObjectLambdaEndpoint?: boolean;
                                                                                                                                                                                                                                                                          UseS3ExpressControlEndpoint?: boolean;
                                                                                                                                                                                                                                                                          [name: string]: string | boolean | string[];
                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                      • [name: string]: string | boolean | string[]
                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                      Accelerate? Bucket? CopySource? DisableAccessPoints? diff --git a/docs/interfaces/_internal_.ErrnoException.html b/docs/interfaces/_internal_.ErrnoException.html index 73e6aa20..4f4c26bb 100644 --- a/docs/interfaces/_internal_.ErrnoException.html +++ b/docs/interfaces/_internal_.ErrnoException.html @@ -1,4 +1,4 @@ -ErrnoException | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                        Interface ErrnoException

                                                                                                                                                                                                                                                                        interface ErrnoException {
                                                                                                                                                                                                                                                                            cause?: unknown;
                                                                                                                                                                                                                                                                            code?: string;
                                                                                                                                                                                                                                                                            errno?: number;
                                                                                                                                                                                                                                                                            message: string;
                                                                                                                                                                                                                                                                            name: string;
                                                                                                                                                                                                                                                                            path?: string;
                                                                                                                                                                                                                                                                            stack?: string;
                                                                                                                                                                                                                                                                            syscall?: string;
                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                        • Error
                                                                                                                                                                                                                                                                          • ErrnoException
                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        cause? +ErrnoException | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                          Interface ErrnoException

                                                                                                                                                                                                                                                                          interface ErrnoException {
                                                                                                                                                                                                                                                                              cause?: unknown;
                                                                                                                                                                                                                                                                              code?: string;
                                                                                                                                                                                                                                                                              errno?: number;
                                                                                                                                                                                                                                                                              message: string;
                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                              path?: string;
                                                                                                                                                                                                                                                                              stack?: string;
                                                                                                                                                                                                                                                                              syscall?: string;
                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                          • Error
                                                                                                                                                                                                                                                                            • ErrnoException
                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          cause? code? errno? message diff --git a/docs/interfaces/_internal_.Event.html b/docs/interfaces/_internal_.Event.html index 70230c8a..a4c3a12c 100644 --- a/docs/interfaces/_internal_.Event.html +++ b/docs/interfaces/_internal_.Event.html @@ -1,4 +1,4 @@ -Event | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                            Interface Event

                                                                                                                                                                                                                                                                            interface Event {
                                                                                                                                                                                                                                                                                bubbles: boolean;
                                                                                                                                                                                                                                                                                cancelable: boolean;
                                                                                                                                                                                                                                                                                cancelBubble: boolean;
                                                                                                                                                                                                                                                                                composed: boolean;
                                                                                                                                                                                                                                                                                currentTarget: EventTarget;
                                                                                                                                                                                                                                                                                defaultPrevented: boolean;
                                                                                                                                                                                                                                                                                eventPhase: 0 | 2;
                                                                                                                                                                                                                                                                                isTrusted: boolean;
                                                                                                                                                                                                                                                                                returnValue: boolean;
                                                                                                                                                                                                                                                                                srcElement: EventTarget;
                                                                                                                                                                                                                                                                                target: EventTarget;
                                                                                                                                                                                                                                                                                timeStamp: number;
                                                                                                                                                                                                                                                                                type: string;
                                                                                                                                                                                                                                                                                composedPath(): [EventTarget?];
                                                                                                                                                                                                                                                                                initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
                                                                                                                                                                                                                                                                                preventDefault(): void;
                                                                                                                                                                                                                                                                                stopImmediatePropagation(): void;
                                                                                                                                                                                                                                                                                stopPropagation(): void;
                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                            bubbles +Event | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                              Interface Event

                                                                                                                                                                                                                                                                              interface Event {
                                                                                                                                                                                                                                                                                  bubbles: boolean;
                                                                                                                                                                                                                                                                                  cancelable: boolean;
                                                                                                                                                                                                                                                                                  cancelBubble: boolean;
                                                                                                                                                                                                                                                                                  composed: boolean;
                                                                                                                                                                                                                                                                                  currentTarget: EventTarget;
                                                                                                                                                                                                                                                                                  defaultPrevented: boolean;
                                                                                                                                                                                                                                                                                  eventPhase: 0 | 2;
                                                                                                                                                                                                                                                                                  isTrusted: boolean;
                                                                                                                                                                                                                                                                                  returnValue: boolean;
                                                                                                                                                                                                                                                                                  srcElement: EventTarget;
                                                                                                                                                                                                                                                                                  target: EventTarget;
                                                                                                                                                                                                                                                                                  timeStamp: number;
                                                                                                                                                                                                                                                                                  type: string;
                                                                                                                                                                                                                                                                                  composedPath(): [EventTarget?];
                                                                                                                                                                                                                                                                                  initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
                                                                                                                                                                                                                                                                                  preventDefault(): void;
                                                                                                                                                                                                                                                                                  stopImmediatePropagation(): void;
                                                                                                                                                                                                                                                                                  stopPropagation(): void;
                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              bubbles cancelable cancelBubble composed diff --git a/docs/interfaces/_internal_.EventEmitter.Abortable.html b/docs/interfaces/_internal_.EventEmitter.Abortable.html index 86b2345a..8ca29aae 100644 --- a/docs/interfaces/_internal_.EventEmitter.Abortable.html +++ b/docs/interfaces/_internal_.EventEmitter.Abortable.html @@ -1,3 +1,3 @@ -Abortable | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                Interface Abortable

                                                                                                                                                                                                                                                                                interface Abortable {
                                                                                                                                                                                                                                                                                    signal?: AbortSignal;
                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                signal? +Abortable | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                  Interface Abortable

                                                                                                                                                                                                                                                                                  interface Abortable {
                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  signal?

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  signal?: AbortSignal

                                                                                                                                                                                                                                                                                  When provided the corresponding AbortController can be used to cancel an asynchronous action.

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html b/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html index ad193c80..733c0874 100644 --- a/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html +++ b/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html @@ -1,4 +1,4 @@ -EventEmitterAsyncResourceOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                    Interface EventEmitterAsyncResourceOptions

                                                                                                                                                                                                                                                                                    interface EventEmitterAsyncResourceOptions {
                                                                                                                                                                                                                                                                                        captureRejections?: boolean;
                                                                                                                                                                                                                                                                                        name?: string;
                                                                                                                                                                                                                                                                                        requireManualDestroy?: boolean;
                                                                                                                                                                                                                                                                                        triggerAsyncId?: number;
                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                    captureRejections? +EventEmitterAsyncResourceOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                      Interface EventEmitterAsyncResourceOptions

                                                                                                                                                                                                                                                                                      interface EventEmitterAsyncResourceOptions {
                                                                                                                                                                                                                                                                                          captureRejections?: boolean;
                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                          requireManualDestroy?: boolean;
                                                                                                                                                                                                                                                                                          triggerAsyncId?: number;
                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      captureRejections? name? requireManualDestroy? triggerAsyncId? diff --git a/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html b/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html index 2952e620..45b2037b 100644 --- a/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html +++ b/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html @@ -6,7 +6,7 @@ 
                                                                                                                                                                                                                                                                                      import { AsyncResource, executionAsyncId } from 'node:async_hooks';

                                                                                                                                                                                                                                                                                      // AsyncResource() is meant to be extended. Instantiating a
                                                                                                                                                                                                                                                                                      // new AsyncResource() also triggers init. If triggerAsyncId is omitted then
                                                                                                                                                                                                                                                                                      // async_hook.executionAsyncId() is used.
                                                                                                                                                                                                                                                                                      const asyncResource = new AsyncResource(
                                                                                                                                                                                                                                                                                        type, { triggerAsyncId: executionAsyncId(), requireManualDestroy: false },
                                                                                                                                                                                                                                                                                      );

                                                                                                                                                                                                                                                                                      // Run a function in the execution context of the resource. This will
                                                                                                                                                                                                                                                                                      // * establish the context of the resource
                                                                                                                                                                                                                                                                                      // * trigger the AsyncHooks before callbacks
                                                                                                                                                                                                                                                                                      // * call the provided function `fn` with the supplied arguments
                                                                                                                                                                                                                                                                                      // * trigger the AsyncHooks after callbacks
                                                                                                                                                                                                                                                                                      // * restore the original execution context
                                                                                                                                                                                                                                                                                      asyncResource.runInAsyncScope(fn, thisArg, ...args);

                                                                                                                                                                                                                                                                                      // Call AsyncHooks destroy callbacks.
                                                                                                                                                                                                                                                                                      asyncResource.emitDestroy();

                                                                                                                                                                                                                                                                                      // Return the unique ID assigned to the AsyncResource instance.
                                                                                                                                                                                                                                                                                      asyncResource.asyncId();

                                                                                                                                                                                                                                                                                      // Return the trigger ID for the AsyncResource instance.
                                                                                                                                                                                                                                                                                      asyncResource.triggerAsyncId();
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      interface EventEmitterReferencingAsyncResource {
                                                                                                                                                                                                                                                                                          eventEmitter: EventEmitterAsyncResource;
                                                                                                                                                                                                                                                                                          asyncId(): number;
                                                                                                                                                                                                                                                                                          bind<Func extends (...args: any[]) => any>(fn: Func): Func;
                                                                                                                                                                                                                                                                                          emitDestroy(): this;
                                                                                                                                                                                                                                                                                          runInAsyncScope<This, Result>(
                                                                                                                                                                                                                                                                                              fn: (this: This, ...args: any[]) => Result,
                                                                                                                                                                                                                                                                                              thisArg?: This,
                                                                                                                                                                                                                                                                                              ...args: any[],
                                                                                                                                                                                                                                                                                          ): Result;
                                                                                                                                                                                                                                                                                          triggerAsyncId(): number;
                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      eventEmitter +
                                                                                                                                                                                                                                                                                      interface EventEmitterReferencingAsyncResource {
                                                                                                                                                                                                                                                                                          eventEmitter: EventEmitterAsyncResource;
                                                                                                                                                                                                                                                                                          asyncId(): number;
                                                                                                                                                                                                                                                                                          bind<Func extends (...args: any[]) => any>(fn: Func): Func;
                                                                                                                                                                                                                                                                                          emitDestroy(): this;
                                                                                                                                                                                                                                                                                          runInAsyncScope<This, Result>(
                                                                                                                                                                                                                                                                                              fn: (this: This, ...args: any[]) => Result,
                                                                                                                                                                                                                                                                                              thisArg?: This,
                                                                                                                                                                                                                                                                                              ...args: any[],
                                                                                                                                                                                                                                                                                          ): Result;
                                                                                                                                                                                                                                                                                          triggerAsyncId(): number;
                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      eventEmitter

                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                      asyncId bind emitDestroy diff --git a/docs/interfaces/_internal_.EventEmitter.NodeEventTarget.html b/docs/interfaces/_internal_.EventEmitter.NodeEventTarget.html index 0cb199a1..7e7f775a 100644 --- a/docs/interfaces/_internal_.EventEmitter.NodeEventTarget.html +++ b/docs/interfaces/_internal_.EventEmitter.NodeEventTarget.html @@ -1,7 +1,7 @@ NodeEventTarget | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                        Interface NodeEventTarget

                                                                                                                                                                                                                                                                                        The NodeEventTarget is a Node.js-specific extension to EventTarget that emulates a subset of the EventEmitter API.

                                                                                                                                                                                                                                                                                        v14.5.0

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        interface NodeEventTarget {
                                                                                                                                                                                                                                                                                            addEventListener(
                                                                                                                                                                                                                                                                                                type: string,
                                                                                                                                                                                                                                                                                                listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                options?: boolean | AddEventListenerOptions,
                                                                                                                                                                                                                                                                                            ): void;
                                                                                                                                                                                                                                                                                            addListener(type: string, listener: (arg: any) => void): this;
                                                                                                                                                                                                                                                                                            dispatchEvent(event: Event): boolean;
                                                                                                                                                                                                                                                                                            emit(type: string, arg: any): boolean;
                                                                                                                                                                                                                                                                                            eventNames(): string[];
                                                                                                                                                                                                                                                                                            getMaxListeners(): number;
                                                                                                                                                                                                                                                                                            listenerCount(type: string): number;
                                                                                                                                                                                                                                                                                            off(
                                                                                                                                                                                                                                                                                                type: string,
                                                                                                                                                                                                                                                                                                listener: (arg: any) => void,
                                                                                                                                                                                                                                                                                                options?: EventListenerOptions,
                                                                                                                                                                                                                                                                                            ): this;
                                                                                                                                                                                                                                                                                            on(type: string, listener: (arg: any) => void): this;
                                                                                                                                                                                                                                                                                            once(type: string, listener: (arg: any) => void): this;
                                                                                                                                                                                                                                                                                            removeAllListeners(type?: string): this;
                                                                                                                                                                                                                                                                                            removeEventListener(
                                                                                                                                                                                                                                                                                                type: string,
                                                                                                                                                                                                                                                                                                listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                options?: boolean | EventListenerOptions,
                                                                                                                                                                                                                                                                                            ): void;
                                                                                                                                                                                                                                                                                            removeListener(
                                                                                                                                                                                                                                                                                                type: string,
                                                                                                                                                                                                                                                                                                listener: (arg: any) => void,
                                                                                                                                                                                                                                                                                                options?: EventListenerOptions,
                                                                                                                                                                                                                                                                                            ): this;
                                                                                                                                                                                                                                                                                            setMaxListeners(n: number): void;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                        addEventListener +
                                                                                                                                                                                                                                                                                        interface NodeEventTarget {
                                                                                                                                                                                                                                                                                            addEventListener(
                                                                                                                                                                                                                                                                                                type: string,
                                                                                                                                                                                                                                                                                                listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                options?: boolean | AddEventListenerOptions,
                                                                                                                                                                                                                                                                                            ): void;
                                                                                                                                                                                                                                                                                            addListener(type: string, listener: (arg: any) => void): this;
                                                                                                                                                                                                                                                                                            dispatchEvent(event: Event): boolean;
                                                                                                                                                                                                                                                                                            emit(type: string, arg: any): boolean;
                                                                                                                                                                                                                                                                                            eventNames(): string[];
                                                                                                                                                                                                                                                                                            getMaxListeners(): number;
                                                                                                                                                                                                                                                                                            listenerCount(type: string): number;
                                                                                                                                                                                                                                                                                            off(
                                                                                                                                                                                                                                                                                                type: string,
                                                                                                                                                                                                                                                                                                listener: (arg: any) => void,
                                                                                                                                                                                                                                                                                                options?: EventListenerOptions,
                                                                                                                                                                                                                                                                                            ): this;
                                                                                                                                                                                                                                                                                            on(type: string, listener: (arg: any) => void): this;
                                                                                                                                                                                                                                                                                            once(type: string, listener: (arg: any) => void): this;
                                                                                                                                                                                                                                                                                            removeAllListeners(type?: string): this;
                                                                                                                                                                                                                                                                                            removeEventListener(
                                                                                                                                                                                                                                                                                                type: string,
                                                                                                                                                                                                                                                                                                listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                options?: boolean | EventListenerOptions,
                                                                                                                                                                                                                                                                                            ): void;
                                                                                                                                                                                                                                                                                            removeListener(
                                                                                                                                                                                                                                                                                                type: string,
                                                                                                                                                                                                                                                                                                listener: (arg: any) => void,
                                                                                                                                                                                                                                                                                                options?: EventListenerOptions,
                                                                                                                                                                                                                                                                                            ): this;
                                                                                                                                                                                                                                                                                            setMaxListeners(n: number): void;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                        addEventListener addListener dispatchEvent emit diff --git a/docs/interfaces/_internal_.EventEmitter.html b/docs/interfaces/_internal_.EventEmitter.html index 9a6fbaf2..f41f376e 100644 --- a/docs/interfaces/_internal_.EventEmitter.html +++ b/docs/interfaces/_internal_.EventEmitter.html @@ -1,4 +1,4 @@ -EventEmitter | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                          Interface EventEmitter<T>

                                                                                                                                                                                                                                                                                          interface EventEmitter<T extends EventMap<T> = DefaultEventMap> {
                                                                                                                                                                                                                                                                                              "[captureRejectionSymbol]"?<K>(
                                                                                                                                                                                                                                                                                                  error: Error,
                                                                                                                                                                                                                                                                                                  event: Key<K, T>,
                                                                                                                                                                                                                                                                                                  ...args: Args<K, T>,
                                                                                                                                                                                                                                                                                              ): void;
                                                                                                                                                                                                                                                                                              addListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                              emit<K>(eventName: Key<K, T>, ...args: Args<K, T>): boolean;
                                                                                                                                                                                                                                                                                              eventNames(): ((string | symbol) & Key2<unknown, T>)[];
                                                                                                                                                                                                                                                                                              getMaxListeners(): number;
                                                                                                                                                                                                                                                                                              listenerCount<K>(eventName: Key<K, T>, listener?: Listener<K, T>): number;
                                                                                                                                                                                                                                                                                              listeners<K>(eventName: Key<K, T>): Listener<K, T, Function>[];
                                                                                                                                                                                                                                                                                              off<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                              on<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                              once<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                              prependListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                              prependOnceListener<K>(
                                                                                                                                                                                                                                                                                                  eventName: Key<K, T>,
                                                                                                                                                                                                                                                                                                  listener: Listener<K, T>,
                                                                                                                                                                                                                                                                                              ): this;
                                                                                                                                                                                                                                                                                              rawListeners<K>(eventName: Key<K, T>): Listener<K, T, Function>[];
                                                                                                                                                                                                                                                                                              removeAllListeners(eventName?: Key<unknown, T>): this;
                                                                                                                                                                                                                                                                                              removeListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                              setMaxListeners(n: number): this;
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                          [captureRejectionSymbol]? +EventEmitter | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                            Interface EventEmitter<T>

                                                                                                                                                                                                                                                                                            interface EventEmitter<T extends EventMap<T> = DefaultEventMap> {
                                                                                                                                                                                                                                                                                                "[captureRejectionSymbol]"?<K>(
                                                                                                                                                                                                                                                                                                    error: Error,
                                                                                                                                                                                                                                                                                                    event: Key<K, T>,
                                                                                                                                                                                                                                                                                                    ...args: Args<K, T>,
                                                                                                                                                                                                                                                                                                ): void;
                                                                                                                                                                                                                                                                                                addListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                emit<K>(eventName: Key<K, T>, ...args: Args<K, T>): boolean;
                                                                                                                                                                                                                                                                                                eventNames(): ((string | symbol) & Key2<unknown, T>)[];
                                                                                                                                                                                                                                                                                                getMaxListeners(): number;
                                                                                                                                                                                                                                                                                                listenerCount<K>(eventName: Key<K, T>, listener?: Listener<K, T>): number;
                                                                                                                                                                                                                                                                                                listeners<K>(eventName: Key<K, T>): Listener<K, T, Function>[];
                                                                                                                                                                                                                                                                                                off<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                on<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                once<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                prependListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                prependOnceListener<K>(
                                                                                                                                                                                                                                                                                                    eventName: Key<K, T>,
                                                                                                                                                                                                                                                                                                    listener: Listener<K, T>,
                                                                                                                                                                                                                                                                                                ): this;
                                                                                                                                                                                                                                                                                                rawListeners<K>(eventName: Key<K, T>): Listener<K, T, Function>[];
                                                                                                                                                                                                                                                                                                removeAllListeners(eventName?: Key<unknown, T>): this;
                                                                                                                                                                                                                                                                                                removeListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                setMaxListeners(n: number): this;
                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                            [captureRejectionSymbol]? addListener emit eventNames diff --git a/docs/interfaces/_internal_.EventEmitterOptions.html b/docs/interfaces/_internal_.EventEmitterOptions.html index 4ab6b2e1..39bc77d0 100644 --- a/docs/interfaces/_internal_.EventEmitterOptions.html +++ b/docs/interfaces/_internal_.EventEmitterOptions.html @@ -1,3 +1,3 @@ -EventEmitterOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                              Interface EventEmitterOptions

                                                                                                                                                                                                                                                                                              interface EventEmitterOptions {
                                                                                                                                                                                                                                                                                                  captureRejections?: boolean;
                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              captureRejections? +EventEmitterOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                Interface EventEmitterOptions

                                                                                                                                                                                                                                                                                                interface EventEmitterOptions {
                                                                                                                                                                                                                                                                                                    captureRejections?: boolean;
                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                captureRejections?

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                captureRejections?: boolean

                                                                                                                                                                                                                                                                                                Enables automatic capturing of promise rejection.

                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.EventListenerOptions-1.html b/docs/interfaces/_internal_.EventListenerOptions-1.html index 3c65c725..b4ca1c61 100644 --- a/docs/interfaces/_internal_.EventListenerOptions-1.html +++ b/docs/interfaces/_internal_.EventListenerOptions-1.html @@ -1,2 +1,2 @@ -EventListenerOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                  Interface EventListenerOptions

                                                                                                                                                                                                                                                                                                  interface EventListenerOptions {
                                                                                                                                                                                                                                                                                                      capture?: boolean;
                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  capture? +EventListenerOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                    Interface EventListenerOptions

                                                                                                                                                                                                                                                                                                    interface EventListenerOptions {
                                                                                                                                                                                                                                                                                                        capture?: boolean;
                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                    capture?

                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                    capture?: boolean

                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.EventListenerOptions.html b/docs/interfaces/_internal_.EventListenerOptions.html index 47c7577b..f60c4a5f 100644 --- a/docs/interfaces/_internal_.EventListenerOptions.html +++ b/docs/interfaces/_internal_.EventListenerOptions.html @@ -1,2 +1,2 @@ -EventListenerOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                      Interface EventListenerOptions

                                                                                                                                                                                                                                                                                                      interface EventListenerOptions {
                                                                                                                                                                                                                                                                                                          capture?: boolean;
                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      capture? +EventListenerOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                        Interface EventListenerOptions

                                                                                                                                                                                                                                                                                                        interface EventListenerOptions {
                                                                                                                                                                                                                                                                                                            capture?: boolean;
                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        capture?

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        capture?: boolean

                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.EventTarget.html b/docs/interfaces/_internal_.EventTarget.html index 3d85e3dc..2db164dc 100644 --- a/docs/interfaces/_internal_.EventTarget.html +++ b/docs/interfaces/_internal_.EventTarget.html @@ -1,4 +1,4 @@ -EventTarget | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                          Interface EventTarget

                                                                                                                                                                                                                                                                                                          interface EventTarget {
                                                                                                                                                                                                                                                                                                              addEventListener(
                                                                                                                                                                                                                                                                                                                  type: string,
                                                                                                                                                                                                                                                                                                                  listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                  options?: boolean | AddEventListenerOptions,
                                                                                                                                                                                                                                                                                                              ): void;
                                                                                                                                                                                                                                                                                                              dispatchEvent(event: Event): boolean;
                                                                                                                                                                                                                                                                                                              removeEventListener(
                                                                                                                                                                                                                                                                                                                  type: string,
                                                                                                                                                                                                                                                                                                                  listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                  options?: boolean | EventListenerOptions,
                                                                                                                                                                                                                                                                                                              ): void;
                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                          addEventListener +EventTarget | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                            Interface EventTarget

                                                                                                                                                                                                                                                                                                            interface EventTarget {
                                                                                                                                                                                                                                                                                                                addEventListener(
                                                                                                                                                                                                                                                                                                                    type: string,
                                                                                                                                                                                                                                                                                                                    listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                    options?: boolean | AddEventListenerOptions,
                                                                                                                                                                                                                                                                                                                ): void;
                                                                                                                                                                                                                                                                                                                dispatchEvent(event: Event): boolean;
                                                                                                                                                                                                                                                                                                                removeEventListener(
                                                                                                                                                                                                                                                                                                                    type: string,
                                                                                                                                                                                                                                                                                                                    listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                    options?: boolean | EventListenerOptions,
                                                                                                                                                                                                                                                                                                                ): void;
                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                            addEventListener dispatchEvent removeEventListener

                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                              Returns boolean

                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.ExternalDocumentationObject.html b/docs/interfaces/_internal_.ExternalDocumentationObject.html index 89ae2601..6c9dc2df 100644 --- a/docs/interfaces/_internal_.ExternalDocumentationObject.html +++ b/docs/interfaces/_internal_.ExternalDocumentationObject.html @@ -1,3 +1,3 @@ -ExternalDocumentationObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                              Interface ExternalDocumentationObject

                                                                                                                                                                                                                                                                                                              interface ExternalDocumentationObject {
                                                                                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                                                                                  url: string;
                                                                                                                                                                                                                                                                                                                  [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                              • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              description? +ExternalDocumentationObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                Interface ExternalDocumentationObject

                                                                                                                                                                                                                                                                                                                interface ExternalDocumentationObject {
                                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                                    url: string;
                                                                                                                                                                                                                                                                                                                    [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                description? url

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                description?: string
                                                                                                                                                                                                                                                                                                                url: string

                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.FinalizeHandlerArguments.html b/docs/interfaces/_internal_.FinalizeHandlerArguments.html index 4e07514d..9cdb6660 100644 --- a/docs/interfaces/_internal_.FinalizeHandlerArguments.html +++ b/docs/interfaces/_internal_.FinalizeHandlerArguments.html @@ -1,4 +1,4 @@ -FinalizeHandlerArguments | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                  Interface FinalizeHandlerArguments<Input>

                                                                                                                                                                                                                                                                                                                  interface FinalizeHandlerArguments<Input extends object> {
                                                                                                                                                                                                                                                                                                                      input: Input;
                                                                                                                                                                                                                                                                                                                      request: unknown;
                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                  • Input extends object

                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                  input +FinalizeHandlerArguments | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                    Interface FinalizeHandlerArguments<Input>

                                                                                                                                                                                                                                                                                                                    interface FinalizeHandlerArguments<Input extends object> {
                                                                                                                                                                                                                                                                                                                        input: Input;
                                                                                                                                                                                                                                                                                                                        request: unknown;
                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                    • Input extends object

                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    input request

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    input: Input

                                                                                                                                                                                                                                                                                                                    User input to a command. Reflects the userland representation of the union of data types the command can effectively handle.

                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.FinalizeHandlerOutput.html b/docs/interfaces/_internal_.FinalizeHandlerOutput.html index 01b6a52d..72bd2f72 100644 --- a/docs/interfaces/_internal_.FinalizeHandlerOutput.html +++ b/docs/interfaces/_internal_.FinalizeHandlerOutput.html @@ -1,4 +1,4 @@ -FinalizeHandlerOutput | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                      Interface FinalizeHandlerOutput<Output>

                                                                                                                                                                                                                                                                                                                      interface FinalizeHandlerOutput<Output extends object> {
                                                                                                                                                                                                                                                                                                                          output: Output;
                                                                                                                                                                                                                                                                                                                          response: unknown;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • Output extends object

                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      output +FinalizeHandlerOutput | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                        Interface FinalizeHandlerOutput<Output>

                                                                                                                                                                                                                                                                                                                        interface FinalizeHandlerOutput<Output extends object> {
                                                                                                                                                                                                                                                                                                                            output: Output;
                                                                                                                                                                                                                                                                                                                            response: unknown;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                        • Output extends object

                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                        output response

                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                        output: Output
                                                                                                                                                                                                                                                                                                                        response: unknown

                                                                                                                                                                                                                                                                                                                        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 diff --git a/docs/interfaces/_internal_.Generator.html b/docs/interfaces/_internal_.Generator.html index a56bbb68..8ad6882b 100644 --- a/docs/interfaces/_internal_.Generator.html +++ b/docs/interfaces/_internal_.Generator.html @@ -1,4 +1,4 @@ -Generator | ts-lambda-api - v2.5.3

                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                          Interface Generator<T, TReturn, TNext>

                                                                                                                                                                                                                                                                                                                          interface Generator<T = unknown, TReturn = any, TNext = any> {
                                                                                                                                                                                                                                                                                                                              "[dispose]"(): void;
                                                                                                                                                                                                                                                                                                                              "[iterator]"(): Generator<T, TReturn, TNext>;
                                                                                                                                                                                                                                                                                                                              next(...__namedParameters: [] | [TNext]): IteratorResult<T, TReturn>;
                                                                                                                                                                                                                                                                                                                              return(value: TReturn): IteratorResult<T, TReturn>;
                                                                                                                                                                                                                                                                                                                              throw(e: any): IteratorResult<T, TReturn>;
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                          • T = unknown
                                                                                                                                                                                                                                                                                                                          • TReturn = any
                                                                                                                                                                                                                                                                                                                          • TNext = any

                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                          [dispose] +Generator | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                            Interface Generator<T, TReturn, TNext>

                                                                                                                                                                                                                                                                                                                            interface Generator<T = unknown, TReturn = any, TNext = any> {
                                                                                                                                                                                                                                                                                                                                "[dispose]"(): void;
                                                                                                                                                                                                                                                                                                                                "[iterator]"(): Generator<T, TReturn, TNext>;
                                                                                                                                                                                                                                                                                                                                next(...__namedParameters: [] | [TNext]): IteratorResult<T, TReturn>;
                                                                                                                                                                                                                                                                                                                                return(value: TReturn): IteratorResult<T, TReturn>;
                                                                                                                                                                                                                                                                                                                                throw(e: any): IteratorResult<T, TReturn>;
                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                            • T = unknown
                                                                                                                                                                                                                                                                                                                            • TReturn = any
                                                                                                                                                                                                                                                                                                                            • TNext = any

                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                            [dispose] [iterator] next return diff --git a/docs/interfaces/_internal_.GetAllOptions.html b/docs/interfaces/_internal_.GetAllOptions.html index eccd137e..5f8adc92 100644 --- a/docs/interfaces/_internal_.GetAllOptions.html +++ b/docs/interfaces/_internal_.GetAllOptions.html @@ -1,4 +1,4 @@ -GetAllOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                              Interface GetAllOptions

                                                                                                                                                                                                                                                                                                                              interface GetAllOptions {
                                                                                                                                                                                                                                                                                                                                  autobind?: boolean;
                                                                                                                                                                                                                                                                                                                                  chained?: boolean;
                                                                                                                                                                                                                                                                                                                                  name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                  optional?: boolean;
                                                                                                                                                                                                                                                                                                                                  tag?: GetOptionsTagConstraint;
                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              autobind? +GetAllOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                Interface GetAllOptions

                                                                                                                                                                                                                                                                                                                                interface GetAllOptions {
                                                                                                                                                                                                                                                                                                                                    autobind?: boolean;
                                                                                                                                                                                                                                                                                                                                    chained?: boolean;
                                                                                                                                                                                                                                                                                                                                    name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                    optional?: boolean;
                                                                                                                                                                                                                                                                                                                                    tag?: GetOptionsTagConstraint;
                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                autobind? chained? name? optional? diff --git a/docs/interfaces/_internal_.GetOperation.html b/docs/interfaces/_internal_.GetOperation.html index 0e6fa831..a672945c 100644 --- a/docs/interfaces/_internal_.GetOperation.html +++ b/docs/interfaces/_internal_.GetOperation.html @@ -1,4 +1,4 @@ -GetOperation | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                  Interface GetOperation<T>

                                                                                                                                                                                                                                                                                                                                  interface GetOperation<T> {
                                                                                                                                                                                                                                                                                                                                      op: "_get";
                                                                                                                                                                                                                                                                                                                                      path: string;
                                                                                                                                                                                                                                                                                                                                      value: T;
                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                  • T

                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  op +GetOperation | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                    Interface GetOperation<T>

                                                                                                                                                                                                                                                                                                                                    interface GetOperation<T> {
                                                                                                                                                                                                                                                                                                                                        op: "_get";
                                                                                                                                                                                                                                                                                                                                        path: string;
                                                                                                                                                                                                                                                                                                                                        value: T;
                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    op path value

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    op: "_get"
                                                                                                                                                                                                                                                                                                                                    path: string
                                                                                                                                                                                                                                                                                                                                    value: T

                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.GetOptions.html b/docs/interfaces/_internal_.GetOptions.html index 046d58dd..6c66f015 100644 --- a/docs/interfaces/_internal_.GetOptions.html +++ b/docs/interfaces/_internal_.GetOptions.html @@ -1,4 +1,4 @@ -GetOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                      Interface GetOptions

                                                                                                                                                                                                                                                                                                                                      interface GetOptions {
                                                                                                                                                                                                                                                                                                                                          autobind?: boolean;
                                                                                                                                                                                                                                                                                                                                          name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                          optional?: boolean;
                                                                                                                                                                                                                                                                                                                                          tag?: GetOptionsTagConstraint;
                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      autobind? +GetOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                        Interface GetOptions

                                                                                                                                                                                                                                                                                                                                        interface GetOptions {
                                                                                                                                                                                                                                                                                                                                            autobind?: boolean;
                                                                                                                                                                                                                                                                                                                                            name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                            optional?: boolean;
                                                                                                                                                                                                                                                                                                                                            tag?: GetOptionsTagConstraint;
                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                        autobind? name? optional? tag? diff --git a/docs/interfaces/_internal_.HeaderObject.html b/docs/interfaces/_internal_.HeaderObject.html index 5040faf4..ebecc528 100644 --- a/docs/interfaces/_internal_.HeaderObject.html +++ b/docs/interfaces/_internal_.HeaderObject.html @@ -1,4 +1,4 @@ -HeaderObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                          Interface HeaderObject

                                                                                                                                                                                                                                                                                                                                          interface HeaderObject {
                                                                                                                                                                                                                                                                                                                                              $ref?: string;
                                                                                                                                                                                                                                                                                                                                              allowEmptyValue?: boolean;
                                                                                                                                                                                                                                                                                                                                              allowReserved?: boolean;
                                                                                                                                                                                                                                                                                                                                              content?: ContentObject;
                                                                                                                                                                                                                                                                                                                                              deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                              example?: any;
                                                                                                                                                                                                                                                                                                                                              examples?: { [param: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                                                                                                                                                                                              explode?: boolean;
                                                                                                                                                                                                                                                                                                                                              required?: boolean;
                                                                                                                                                                                                                                                                                                                                              schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                              style?: ParameterStyle;
                                                                                                                                                                                                                                                                                                                                              [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                          • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          $ref? +HeaderObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                            Interface HeaderObject

                                                                                                                                                                                                                                                                                                                                            interface HeaderObject {
                                                                                                                                                                                                                                                                                                                                                $ref?: string;
                                                                                                                                                                                                                                                                                                                                                allowEmptyValue?: boolean;
                                                                                                                                                                                                                                                                                                                                                allowReserved?: boolean;
                                                                                                                                                                                                                                                                                                                                                content?: ContentObject;
                                                                                                                                                                                                                                                                                                                                                deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                example?: any;
                                                                                                                                                                                                                                                                                                                                                examples?: { [param: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                                                                                                                                                                                                explode?: boolean;
                                                                                                                                                                                                                                                                                                                                                required?: boolean;
                                                                                                                                                                                                                                                                                                                                                schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                style?: ParameterStyle;
                                                                                                                                                                                                                                                                                                                                                [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                            • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                            $ref? allowEmptyValue? allowReserved? content? diff --git a/docs/interfaces/_internal_.Headers.html b/docs/interfaces/_internal_.Headers.html index 9d103def..35dac5b7 100644 --- a/docs/interfaces/_internal_.Headers.html +++ b/docs/interfaces/_internal_.Headers.html @@ -1,4 +1,4 @@ -Headers | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                              Interface Headers

                                                                                                                                                                                                                                                                                                                                              interface Headers {
                                                                                                                                                                                                                                                                                                                                                  "[iterator]": () => SpecIterableIterator<[string, string]>;
                                                                                                                                                                                                                                                                                                                                                  append: (name: string, value: string) => void;
                                                                                                                                                                                                                                                                                                                                                  delete: (name: string) => void;
                                                                                                                                                                                                                                                                                                                                                  entries: () => SpecIterableIterator<[string, string]>;
                                                                                                                                                                                                                                                                                                                                                  forEach: (
                                                                                                                                                                                                                                                                                                                                                      callbackfn: (value: string, key: string, iterable: Headers) => void,
                                                                                                                                                                                                                                                                                                                                                      thisArg?: unknown,
                                                                                                                                                                                                                                                                                                                                                  ) => void;
                                                                                                                                                                                                                                                                                                                                                  get: (name: string) => string;
                                                                                                                                                                                                                                                                                                                                                  getSetCookie: () => string[];
                                                                                                                                                                                                                                                                                                                                                  has: (name: string) => boolean;
                                                                                                                                                                                                                                                                                                                                                  keys: () => SpecIterableIterator<string>;
                                                                                                                                                                                                                                                                                                                                                  set: (name: string, value: string) => void;
                                                                                                                                                                                                                                                                                                                                                  values: () => SpecIterableIterator<string>;
                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              [iterator] +Headers | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                Interface Headers

                                                                                                                                                                                                                                                                                                                                                interface Headers {
                                                                                                                                                                                                                                                                                                                                                    "[iterator]": () => SpecIterableIterator<[string, string]>;
                                                                                                                                                                                                                                                                                                                                                    append: (name: string, value: string) => void;
                                                                                                                                                                                                                                                                                                                                                    delete: (name: string) => void;
                                                                                                                                                                                                                                                                                                                                                    entries: () => SpecIterableIterator<[string, string]>;
                                                                                                                                                                                                                                                                                                                                                    forEach: (
                                                                                                                                                                                                                                                                                                                                                        callbackfn: (value: string, key: string, iterable: Headers) => void,
                                                                                                                                                                                                                                                                                                                                                        thisArg?: unknown,
                                                                                                                                                                                                                                                                                                                                                    ) => void;
                                                                                                                                                                                                                                                                                                                                                    get: (name: string) => string;
                                                                                                                                                                                                                                                                                                                                                    getSetCookie: () => string[];
                                                                                                                                                                                                                                                                                                                                                    has: (name: string) => boolean;
                                                                                                                                                                                                                                                                                                                                                    keys: () => SpecIterableIterator<string>;
                                                                                                                                                                                                                                                                                                                                                    set: (name: string, value: string) => void;
                                                                                                                                                                                                                                                                                                                                                    values: () => SpecIterableIterator<string>;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                [iterator] append delete entries diff --git a/docs/interfaces/_internal_.HttpAuthExtensionConfiguration.html b/docs/interfaces/_internal_.HttpAuthExtensionConfiguration.html index 901ad107..3efc2fb2 100644 --- a/docs/interfaces/_internal_.HttpAuthExtensionConfiguration.html +++ b/docs/interfaces/_internal_.HttpAuthExtensionConfiguration.html @@ -1,4 +1,4 @@ -HttpAuthExtensionConfiguration | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                  Interface HttpAuthExtensionConfigurationInternal

                                                                                                                                                                                                                                                                                                                                                  interface HttpAuthExtensionConfiguration {
                                                                                                                                                                                                                                                                                                                                                      credentials(): AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                      httpAuthSchemeProvider(): S3HttpAuthSchemeProvider;
                                                                                                                                                                                                                                                                                                                                                      httpAuthSchemes(): HttpAuthScheme[];
                                                                                                                                                                                                                                                                                                                                                      setCredentials(
                                                                                                                                                                                                                                                                                                                                                          credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider,
                                                                                                                                                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                                                                                                                                                      setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
                                                                                                                                                                                                                                                                                                                                                      setHttpAuthSchemeProvider(
                                                                                                                                                                                                                                                                                                                                                          httpAuthSchemeProvider: S3HttpAuthSchemeProvider,
                                                                                                                                                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                  credentials +HttpAuthExtensionConfiguration | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                    Interface HttpAuthExtensionConfigurationInternal

                                                                                                                                                                                                                                                                                                                                                    interface HttpAuthExtensionConfiguration {
                                                                                                                                                                                                                                                                                                                                                        credentials(): AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                        httpAuthSchemeProvider(): S3HttpAuthSchemeProvider;
                                                                                                                                                                                                                                                                                                                                                        httpAuthSchemes(): HttpAuthScheme[];
                                                                                                                                                                                                                                                                                                                                                        setCredentials(
                                                                                                                                                                                                                                                                                                                                                            credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider,
                                                                                                                                                                                                                                                                                                                                                        ): void;
                                                                                                                                                                                                                                                                                                                                                        setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
                                                                                                                                                                                                                                                                                                                                                        setHttpAuthSchemeProvider(
                                                                                                                                                                                                                                                                                                                                                            httpAuthSchemeProvider: S3HttpAuthSchemeProvider,
                                                                                                                                                                                                                                                                                                                                                        ): void;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                    credentials httpAuthSchemeProvider httpAuthSchemes setCredentials diff --git a/docs/interfaces/_internal_.HttpAuthSchemeInputConfig.html b/docs/interfaces/_internal_.HttpAuthSchemeInputConfig.html index ea9f69c5..c2829042 100644 --- a/docs/interfaces/_internal_.HttpAuthSchemeInputConfig.html +++ b/docs/interfaces/_internal_.HttpAuthSchemeInputConfig.html @@ -1,4 +1,4 @@ -HttpAuthSchemeInputConfig | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                      Interface HttpAuthSchemeInputConfig

                                                                                                                                                                                                                                                                                                                                                      interface HttpAuthSchemeInputConfig {
                                                                                                                                                                                                                                                                                                                                                          authSchemePreference?: string[] | Provider<string[]>;
                                                                                                                                                                                                                                                                                                                                                          credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                          httpAuthSchemeProvider?: S3HttpAuthSchemeProvider;
                                                                                                                                                                                                                                                                                                                                                          httpAuthSchemes?: HttpAuthScheme[];
                                                                                                                                                                                                                                                                                                                                                          signer?:
                                                                                                                                                                                                                                                                                                                                                              | RequestSigner
                                                                                                                                                                                                                                                                                                                                                              | ((authScheme?: AuthScheme) => Promise<RequestSigner>);
                                                                                                                                                                                                                                                                                                                                                          signerConstructor?: new (
                                                                                                                                                                                                                                                                                                                                                              options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                                                                                                                                                                                                                          ) => RequestSigner;
                                                                                                                                                                                                                                                                                                                                                          signingEscapePath?: boolean;
                                                                                                                                                                                                                                                                                                                                                          signingRegion?: string;
                                                                                                                                                                                                                                                                                                                                                          sigv4aSigningRegionSet?: string[] | Provider<string[]>;
                                                                                                                                                                                                                                                                                                                                                          systemClockOffset?: number;
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      authSchemePreference? +HttpAuthSchemeInputConfig | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                        Interface HttpAuthSchemeInputConfig

                                                                                                                                                                                                                                                                                                                                                        interface HttpAuthSchemeInputConfig {
                                                                                                                                                                                                                                                                                                                                                            authSchemePreference?: string[] | Provider<string[]>;
                                                                                                                                                                                                                                                                                                                                                            credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                            httpAuthSchemeProvider?: S3HttpAuthSchemeProvider;
                                                                                                                                                                                                                                                                                                                                                            httpAuthSchemes?: HttpAuthScheme[];
                                                                                                                                                                                                                                                                                                                                                            signer?:
                                                                                                                                                                                                                                                                                                                                                                | RequestSigner
                                                                                                                                                                                                                                                                                                                                                                | ((authScheme?: AuthScheme) => Promise<RequestSigner>);
                                                                                                                                                                                                                                                                                                                                                            signerConstructor?: new (
                                                                                                                                                                                                                                                                                                                                                                options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                                                                                                                                                                                                                            ) => RequestSigner;
                                                                                                                                                                                                                                                                                                                                                            signingEscapePath?: boolean;
                                                                                                                                                                                                                                                                                                                                                            signingRegion?: string;
                                                                                                                                                                                                                                                                                                                                                            sigv4aSigningRegionSet?: string[] | Provider<string[]>;
                                                                                                                                                                                                                                                                                                                                                            systemClockOffset?: number;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        authSchemePreference? credentials? httpAuthSchemeProvider? httpAuthSchemes? diff --git a/docs/interfaces/_internal_.HttpAuthSchemeParameters.html b/docs/interfaces/_internal_.HttpAuthSchemeParameters.html index 8e43057b..31976cc5 100644 --- a/docs/interfaces/_internal_.HttpAuthSchemeParameters.html +++ b/docs/interfaces/_internal_.HttpAuthSchemeParameters.html @@ -1,2 +1,2 @@ -HttpAuthSchemeParameters | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                          Interface HttpAuthSchemeParametersInternal

                                                                                                                                                                                                                                                                                                                                                          interface HttpAuthSchemeParameters {
                                                                                                                                                                                                                                                                                                                                                              operation?: string;
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                          operation? +HttpAuthSchemeParameters | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                            Interface HttpAuthSchemeParametersInternal

                                                                                                                                                                                                                                                                                                                                                            interface HttpAuthSchemeParameters {
                                                                                                                                                                                                                                                                                                                                                                operation?: string;
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                            operation?

                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                            operation?: string

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.HttpAuthSchemeProvider.html b/docs/interfaces/_internal_.HttpAuthSchemeProvider.html index d100fd31..57ca9b85 100644 --- a/docs/interfaces/_internal_.HttpAuthSchemeProvider.html +++ b/docs/interfaces/_internal_.HttpAuthSchemeProvider.html @@ -1 +1 @@ -HttpAuthSchemeProvider | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                              Interface HttpAuthSchemeProvider<TParameters>Internal

                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                              +HttpAuthSchemeProvider | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                Interface HttpAuthSchemeProvider<TParameters>Internal

                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.HttpHandlerExtensionConfiguration.html b/docs/interfaces/_internal_.HttpHandlerExtensionConfiguration.html index 90ae3686..f102e037 100644 --- a/docs/interfaces/_internal_.HttpHandlerExtensionConfiguration.html +++ b/docs/interfaces/_internal_.HttpHandlerExtensionConfiguration.html @@ -1,4 +1,4 @@ -HttpHandlerExtensionConfiguration | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                  Interface HttpHandlerExtensionConfiguration<HandlerConfig>Internal

                                                                                                                                                                                                                                                                                                                                                                  interface HttpHandlerExtensionConfiguration<HandlerConfig extends object = {}> {
                                                                                                                                                                                                                                                                                                                                                                      httpHandler(): HttpHandler<HandlerConfig>;
                                                                                                                                                                                                                                                                                                                                                                      httpHandlerConfigs(): HandlerConfig;
                                                                                                                                                                                                                                                                                                                                                                      setHttpHandler(handler: HttpHandler<HandlerConfig>): void;
                                                                                                                                                                                                                                                                                                                                                                      updateHttpClientConfig(
                                                                                                                                                                                                                                                                                                                                                                          key: keyof HandlerConfig,
                                                                                                                                                                                                                                                                                                                                                                          value: HandlerConfig[keyof HandlerConfig],
                                                                                                                                                                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                  • HandlerConfig extends object = {}

                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                  httpHandler +HttpHandlerExtensionConfiguration | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                    Interface HttpHandlerExtensionConfiguration<HandlerConfig>Internal

                                                                                                                                                                                                                                                                                                                                                                    interface HttpHandlerExtensionConfiguration<HandlerConfig extends object = {}> {
                                                                                                                                                                                                                                                                                                                                                                        httpHandler(): HttpHandler<HandlerConfig>;
                                                                                                                                                                                                                                                                                                                                                                        httpHandlerConfigs(): HandlerConfig;
                                                                                                                                                                                                                                                                                                                                                                        setHttpHandler(handler: HttpHandler<HandlerConfig>): void;
                                                                                                                                                                                                                                                                                                                                                                        updateHttpClientConfig(
                                                                                                                                                                                                                                                                                                                                                                            key: keyof HandlerConfig,
                                                                                                                                                                                                                                                                                                                                                                            value: HandlerConfig[keyof HandlerConfig],
                                                                                                                                                                                                                                                                                                                                                                        ): void;
                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                    • HandlerConfig extends object = {}

                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                    httpHandler httpHandlerConfigs setHttpHandler updateHttpClientConfig diff --git a/docs/interfaces/_internal_.HttpMessage.html b/docs/interfaces/_internal_.HttpMessage.html index 8d76deb2..a6028d34 100644 --- a/docs/interfaces/_internal_.HttpMessage.html +++ b/docs/interfaces/_internal_.HttpMessage.html @@ -1,5 +1,5 @@ HttpMessage | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                      Interface HttpMessage

                                                                                                                                                                                                                                                                                                                                                                      Represents an HTTP message with headers and an optional static or streaming body. body: ArrayBuffer | ArrayBufferView | string | Uint8Array | Readable | ReadableStream;

                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                      interface HttpMessage {
                                                                                                                                                                                                                                                                                                                                                                          body?: any;
                                                                                                                                                                                                                                                                                                                                                                          headers: HeaderBag;
                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                      Implemented by

                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      body? +
                                                                                                                                                                                                                                                                                                                                                                      interface HttpMessage {
                                                                                                                                                                                                                                                                                                                                                                          body?: any;
                                                                                                                                                                                                                                                                                                                                                                          headers: HeaderBag;
                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                      Implemented by

                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      body? headers

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      Optionalbody

                                                                                                                                                                                                                                                                                                                                                                      body?: any
                                                                                                                                                                                                                                                                                                                                                                      headers: HeaderBag

                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.HttpRequest.html b/docs/interfaces/_internal_.HttpRequest.html index ac1e6ed7..d5a82242 100644 --- a/docs/interfaces/_internal_.HttpRequest.html +++ b/docs/interfaces/_internal_.HttpRequest.html @@ -1,6 +1,6 @@ HttpRequest | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                        Interface HttpRequest

                                                                                                                                                                                                                                                                                                                                                                        Interface an HTTP request class. Contains addressing information in addition to standard message properties.

                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                        interface HttpRequest {
                                                                                                                                                                                                                                                                                                                                                                            body?: any;
                                                                                                                                                                                                                                                                                                                                                                            fragment?: string;
                                                                                                                                                                                                                                                                                                                                                                            headers: HeaderBag;
                                                                                                                                                                                                                                                                                                                                                                            hostname: string;
                                                                                                                                                                                                                                                                                                                                                                            method: string;
                                                                                                                                                                                                                                                                                                                                                                            password?: string;
                                                                                                                                                                                                                                                                                                                                                                            path: string;
                                                                                                                                                                                                                                                                                                                                                                            port?: number;
                                                                                                                                                                                                                                                                                                                                                                            protocol: string;
                                                                                                                                                                                                                                                                                                                                                                            query?: QueryParameterBag;
                                                                                                                                                                                                                                                                                                                                                                            username?: string;
                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                        body? +
                                                                                                                                                                                                                                                                                                                                                                        interface HttpRequest {
                                                                                                                                                                                                                                                                                                                                                                            body?: any;
                                                                                                                                                                                                                                                                                                                                                                            fragment?: string;
                                                                                                                                                                                                                                                                                                                                                                            headers: HeaderBag;
                                                                                                                                                                                                                                                                                                                                                                            hostname: string;
                                                                                                                                                                                                                                                                                                                                                                            method: string;
                                                                                                                                                                                                                                                                                                                                                                            password?: string;
                                                                                                                                                                                                                                                                                                                                                                            path: string;
                                                                                                                                                                                                                                                                                                                                                                            port?: number;
                                                                                                                                                                                                                                                                                                                                                                            protocol: string;
                                                                                                                                                                                                                                                                                                                                                                            query?: QueryParameterBag;
                                                                                                                                                                                                                                                                                                                                                                            username?: string;
                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                        body? fragment? headers hostname diff --git a/docs/interfaces/_internal_.HttpResponse.html b/docs/interfaces/_internal_.HttpResponse.html index 4e3c3394..bd839293 100644 --- a/docs/interfaces/_internal_.HttpResponse.html +++ b/docs/interfaces/_internal_.HttpResponse.html @@ -1,6 +1,6 @@ HttpResponse | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                          Interface HttpResponse

                                                                                                                                                                                                                                                                                                                                                                          Represents an HTTP message as received in reply to a request. Contains a numeric status code in addition to standard message properties.

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          interface HttpResponse {
                                                                                                                                                                                                                                                                                                                                                                              body?: any;
                                                                                                                                                                                                                                                                                                                                                                              headers: HeaderBag;
                                                                                                                                                                                                                                                                                                                                                                              reason?: string;
                                                                                                                                                                                                                                                                                                                                                                              statusCode: number;
                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                          body? +
                                                                                                                                                                                                                                                                                                                                                                          interface HttpResponse {
                                                                                                                                                                                                                                                                                                                                                                              body?: any;
                                                                                                                                                                                                                                                                                                                                                                              headers: HeaderBag;
                                                                                                                                                                                                                                                                                                                                                                              reason?: string;
                                                                                                                                                                                                                                                                                                                                                                              statusCode: number;
                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                          body? headers reason? statusCode diff --git a/docs/interfaces/_internal_.Identity.html b/docs/interfaces/_internal_.Identity.html index 94208c7d..93cdb7e6 100644 --- a/docs/interfaces/_internal_.Identity.html +++ b/docs/interfaces/_internal_.Identity.html @@ -1,3 +1,3 @@ -Identity | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                            Interface Identity

                                                                                                                                                                                                                                                                                                                                                                            interface Identity {
                                                                                                                                                                                                                                                                                                                                                                                expiration?: Date;
                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                            expiration? +Identity | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                              Interface Identity

                                                                                                                                                                                                                                                                                                                                                                              interface Identity {
                                                                                                                                                                                                                                                                                                                                                                                  expiration?: Date;
                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                              expiration?

                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                              expiration?: Date

                                                                                                                                                                                                                                                                                                                                                                              A Date when the identity or credential will no longer be accepted.

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.IncomingHttpHeaders.html b/docs/interfaces/_internal_.IncomingHttpHeaders.html index 5f730bb2..e61d9b37 100644 --- a/docs/interfaces/_internal_.IncomingHttpHeaders.html +++ b/docs/interfaces/_internal_.IncomingHttpHeaders.html @@ -1,4 +1,4 @@ -IncomingHttpHeaders | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                Interface IncomingHttpHeaders

                                                                                                                                                                                                                                                                                                                                                                                interface IncomingHttpHeaders {
                                                                                                                                                                                                                                                                                                                                                                                    accept?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "accept-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "accept-language"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "accept-patch"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "accept-ranges"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "access-control-allow-credentials"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "access-control-allow-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "access-control-allow-methods"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "access-control-allow-origin"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "access-control-expose-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "access-control-max-age"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "access-control-request-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "access-control-request-method"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    age?: string;
                                                                                                                                                                                                                                                                                                                                                                                    allow?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "alt-svc"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    authorization?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "cache-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    connection?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "content-disposition"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "content-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "content-language"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "content-length"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "content-location"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "content-range"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "content-type"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    cookie?: string;
                                                                                                                                                                                                                                                                                                                                                                                    date?: string;
                                                                                                                                                                                                                                                                                                                                                                                    etag?: string;
                                                                                                                                                                                                                                                                                                                                                                                    expect?: string;
                                                                                                                                                                                                                                                                                                                                                                                    expires?: string;
                                                                                                                                                                                                                                                                                                                                                                                    forwarded?: string;
                                                                                                                                                                                                                                                                                                                                                                                    from?: string;
                                                                                                                                                                                                                                                                                                                                                                                    host?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "if-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "if-modified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "if-none-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "if-unmodified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "last-modified"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    location?: string;
                                                                                                                                                                                                                                                                                                                                                                                    origin?: string;
                                                                                                                                                                                                                                                                                                                                                                                    pragma?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "proxy-authenticate"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "proxy-authorization"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "public-key-pins"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    range?: string;
                                                                                                                                                                                                                                                                                                                                                                                    referer?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "retry-after"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "sec-fetch-dest"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "sec-fetch-mode"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "sec-fetch-site"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "sec-fetch-user"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "sec-websocket-accept"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "sec-websocket-extensions"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "sec-websocket-key"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "sec-websocket-protocol"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "sec-websocket-version"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "set-cookie"?: string[];
                                                                                                                                                                                                                                                                                                                                                                                    "strict-transport-security"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    tk?: string;
                                                                                                                                                                                                                                                                                                                                                                                    trailer?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "transfer-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    upgrade?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "user-agent"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    vary?: string;
                                                                                                                                                                                                                                                                                                                                                                                    via?: string;
                                                                                                                                                                                                                                                                                                                                                                                    warning?: string;
                                                                                                                                                                                                                                                                                                                                                                                    "www-authenticate"?: string;
                                                                                                                                                                                                                                                                                                                                                                                    [key: string]: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                • Dict<string | string[]>
                                                                                                                                                                                                                                                                                                                                                                                  • IncomingHttpHeaders

                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                • [key: string]: string | string[]
                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                accept? +IncomingHttpHeaders | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                  Interface IncomingHttpHeaders

                                                                                                                                                                                                                                                                                                                                                                                  interface IncomingHttpHeaders {
                                                                                                                                                                                                                                                                                                                                                                                      accept?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "accept-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "accept-language"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "accept-patch"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "accept-ranges"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "access-control-allow-credentials"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "access-control-allow-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "access-control-allow-methods"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "access-control-allow-origin"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "access-control-expose-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "access-control-max-age"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "access-control-request-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "access-control-request-method"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      age?: string;
                                                                                                                                                                                                                                                                                                                                                                                      allow?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "alt-svc"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      authorization?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "cache-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      connection?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "content-disposition"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "content-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "content-language"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "content-length"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "content-location"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "content-range"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "content-type"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      cookie?: string;
                                                                                                                                                                                                                                                                                                                                                                                      date?: string;
                                                                                                                                                                                                                                                                                                                                                                                      etag?: string;
                                                                                                                                                                                                                                                                                                                                                                                      expect?: string;
                                                                                                                                                                                                                                                                                                                                                                                      expires?: string;
                                                                                                                                                                                                                                                                                                                                                                                      forwarded?: string;
                                                                                                                                                                                                                                                                                                                                                                                      from?: string;
                                                                                                                                                                                                                                                                                                                                                                                      host?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "if-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "if-modified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "if-none-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "if-unmodified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "last-modified"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      location?: string;
                                                                                                                                                                                                                                                                                                                                                                                      origin?: string;
                                                                                                                                                                                                                                                                                                                                                                                      pragma?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "proxy-authenticate"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "proxy-authorization"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "public-key-pins"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      range?: string;
                                                                                                                                                                                                                                                                                                                                                                                      referer?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "retry-after"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "sec-fetch-dest"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "sec-fetch-mode"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "sec-fetch-site"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "sec-fetch-user"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "sec-websocket-accept"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "sec-websocket-extensions"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "sec-websocket-key"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "sec-websocket-protocol"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "sec-websocket-version"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "set-cookie"?: string[];
                                                                                                                                                                                                                                                                                                                                                                                      "strict-transport-security"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      tk?: string;
                                                                                                                                                                                                                                                                                                                                                                                      trailer?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "transfer-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      upgrade?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "user-agent"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      vary?: string;
                                                                                                                                                                                                                                                                                                                                                                                      via?: string;
                                                                                                                                                                                                                                                                                                                                                                                      warning?: string;
                                                                                                                                                                                                                                                                                                                                                                                      "www-authenticate"?: string;
                                                                                                                                                                                                                                                                                                                                                                                      [key: string]: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                  • Dict<string | string[]>
                                                                                                                                                                                                                                                                                                                                                                                    • IncomingHttpHeaders

                                                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                                                  • [key: string]: string | string[]
                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                  accept? accept-encoding? accept-language? accept-patch? diff --git a/docs/interfaces/_internal_.InfoObject.html b/docs/interfaces/_internal_.InfoObject.html index 7ae98d83..309d442f 100644 --- a/docs/interfaces/_internal_.InfoObject.html +++ b/docs/interfaces/_internal_.InfoObject.html @@ -1,4 +1,4 @@ -InfoObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                    Interface InfoObject

                                                                                                                                                                                                                                                                                                                                                                                    interface InfoObject {
                                                                                                                                                                                                                                                                                                                                                                                        contact?: ContactObject;
                                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                                        license?: LicenseObject;
                                                                                                                                                                                                                                                                                                                                                                                        termsOfService?: string;
                                                                                                                                                                                                                                                                                                                                                                                        title: string;
                                                                                                                                                                                                                                                                                                                                                                                        version: string;
                                                                                                                                                                                                                                                                                                                                                                                        [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                                                                                    • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                    contact? +InfoObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                      Interface InfoObject

                                                                                                                                                                                                                                                                                                                                                                                      interface InfoObject {
                                                                                                                                                                                                                                                                                                                                                                                          contact?: ContactObject;
                                                                                                                                                                                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                                                                                                                                                                                          license?: LicenseObject;
                                                                                                                                                                                                                                                                                                                                                                                          termsOfService?: string;
                                                                                                                                                                                                                                                                                                                                                                                          title: string;
                                                                                                                                                                                                                                                                                                                                                                                          version: string;
                                                                                                                                                                                                                                                                                                                                                                                          [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                      • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                      contact? description? license? termsOfService? diff --git a/docs/interfaces/_internal_.InitializeHandlerArguments.html b/docs/interfaces/_internal_.InitializeHandlerArguments.html index f1c4f101..41eaf111 100644 --- a/docs/interfaces/_internal_.InitializeHandlerArguments.html +++ b/docs/interfaces/_internal_.InitializeHandlerArguments.html @@ -1,4 +1,4 @@ -InitializeHandlerArguments | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                        Interface InitializeHandlerArguments<Input>

                                                                                                                                                                                                                                                                                                                                                                                        interface InitializeHandlerArguments<Input extends object> {
                                                                                                                                                                                                                                                                                                                                                                                            input: Input;
                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                        • Input extends object

                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                        input +InitializeHandlerArguments | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                          Interface InitializeHandlerArguments<Input>

                                                                                                                                                                                                                                                                                                                                                                                          interface InitializeHandlerArguments<Input extends object> {
                                                                                                                                                                                                                                                                                                                                                                                              input: Input;
                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                          • Input extends object

                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                          input

                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                          input: Input

                                                                                                                                                                                                                                                                                                                                                                                          User input to a command. Reflects the userland representation of the union of data types the command can effectively handle.

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.InitializeHandlerOutput.html b/docs/interfaces/_internal_.InitializeHandlerOutput.html index 48165185..4a680b63 100644 --- a/docs/interfaces/_internal_.InitializeHandlerOutput.html +++ b/docs/interfaces/_internal_.InitializeHandlerOutput.html @@ -1,4 +1,4 @@ -InitializeHandlerOutput | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                            Interface InitializeHandlerOutput<Output>

                                                                                                                                                                                                                                                                                                                                                                                            interface InitializeHandlerOutput<Output extends object> {
                                                                                                                                                                                                                                                                                                                                                                                                output: Output;
                                                                                                                                                                                                                                                                                                                                                                                                response: unknown;
                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                            • Output extends object

                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                            output +InitializeHandlerOutput | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                              Interface InitializeHandlerOutput<Output>

                                                                                                                                                                                                                                                                                                                                                                                              interface InitializeHandlerOutput<Output extends object> {
                                                                                                                                                                                                                                                                                                                                                                                                  output: Output;
                                                                                                                                                                                                                                                                                                                                                                                                  response: unknown;
                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • Output extends object

                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                              output response

                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                              output: Output
                                                                                                                                                                                                                                                                                                                                                                                              response: unknown

                                                                                                                                                                                                                                                                                                                                                                                              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 diff --git a/docs/interfaces/_internal_.LicenseObject.html b/docs/interfaces/_internal_.LicenseObject.html index 22080b67..f17b08c6 100644 --- a/docs/interfaces/_internal_.LicenseObject.html +++ b/docs/interfaces/_internal_.LicenseObject.html @@ -1,4 +1,4 @@ -LicenseObject | ts-lambda-api - v2.5.3

                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                Interface LicenseObject

                                                                                                                                                                                                                                                                                                                                                                                                interface LicenseObject {
                                                                                                                                                                                                                                                                                                                                                                                                    identifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                    name: string;
                                                                                                                                                                                                                                                                                                                                                                                                    url?: string;
                                                                                                                                                                                                                                                                                                                                                                                                    [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                identifier? +LicenseObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                  Interface LicenseObject

                                                                                                                                                                                                                                                                                                                                                                                                  interface LicenseObject {
                                                                                                                                                                                                                                                                                                                                                                                                      identifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                                                                      url?: string;
                                                                                                                                                                                                                                                                                                                                                                                                      [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                                                                  • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  identifier? name url?

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  identifier?: string
                                                                                                                                                                                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                                                                                                                                                                                  url?: string

                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.LinkObject.html b/docs/interfaces/_internal_.LinkObject.html index 468dafc2..75a82bb1 100644 --- a/docs/interfaces/_internal_.LinkObject.html +++ b/docs/interfaces/_internal_.LinkObject.html @@ -1,4 +1,4 @@ -LinkObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                    Interface LinkObject

                                                                                                                                                                                                                                                                                                                                                                                                    interface LinkObject {
                                                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                        operationId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                        operationRef?: string;
                                                                                                                                                                                                                                                                                                                                                                                                        parameters?: LinkParametersObject;
                                                                                                                                                                                                                                                                                                                                                                                                        requestBody?: any;
                                                                                                                                                                                                                                                                                                                                                                                                        server?: ServerObject;
                                                                                                                                                                                                                                                                                                                                                                                                        [property: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                        [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                                                                                                    • [property: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                    • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                    description? +LinkObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                      Interface LinkObject

                                                                                                                                                                                                                                                                                                                                                                                                      interface LinkObject {
                                                                                                                                                                                                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                          operationId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                          operationRef?: string;
                                                                                                                                                                                                                                                                                                                                                                                                          parameters?: LinkParametersObject;
                                                                                                                                                                                                                                                                                                                                                                                                          requestBody?: any;
                                                                                                                                                                                                                                                                                                                                                                                                          server?: ServerObject;
                                                                                                                                                                                                                                                                                                                                                                                                          [property: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                          [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                      • [property: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                      • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                      description? operationId? operationRef? parameters? diff --git a/docs/interfaces/_internal_.ListSchema.html b/docs/interfaces/_internal_.ListSchema.html index bae67083..2c97e654 100644 --- a/docs/interfaces/_internal_.ListSchema.html +++ b/docs/interfaces/_internal_.ListSchema.html @@ -1,6 +1,6 @@ ListSchema | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                        Interface ListSchemaInternal

                                                                                                                                                                                                                                                                                                                                                                                                        Schema for the list aggregate type.

                                                                                                                                                                                                                                                                                                                                                                                                        use static schema.

                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        interface ListSchema {
                                                                                                                                                                                                                                                                                                                                                                                                            name: string;
                                                                                                                                                                                                                                                                                                                                                                                                            namespace: string;
                                                                                                                                                                                                                                                                                                                                                                                                            traits: SchemaTraits;
                                                                                                                                                                                                                                                                                                                                                                                                            valueSchema: SchemaRef;
                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                        name +
                                                                                                                                                                                                                                                                                                                                                                                                        interface ListSchema {
                                                                                                                                                                                                                                                                                                                                                                                                            name: string;
                                                                                                                                                                                                                                                                                                                                                                                                            namespace: string;
                                                                                                                                                                                                                                                                                                                                                                                                            traits: SchemaTraits;
                                                                                                                                                                                                                                                                                                                                                                                                            valueSchema: SchemaRef;
                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                        name namespace traits valueSchema diff --git a/docs/interfaces/_internal_.MapSchema.html b/docs/interfaces/_internal_.MapSchema.html index ee16a3eb..8bf91cea 100644 --- a/docs/interfaces/_internal_.MapSchema.html +++ b/docs/interfaces/_internal_.MapSchema.html @@ -1,6 +1,6 @@ MapSchema | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                          Interface MapSchemaInternal

                                                                                                                                                                                                                                                                                                                                                                                                          Schema for the map aggregate type.

                                                                                                                                                                                                                                                                                                                                                                                                          use static schema.

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          interface MapSchema {
                                                                                                                                                                                                                                                                                                                                                                                                              keySchema: SchemaRef;
                                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                                              namespace: string;
                                                                                                                                                                                                                                                                                                                                                                                                              traits: SchemaTraits;
                                                                                                                                                                                                                                                                                                                                                                                                              valueSchema: SchemaRef;
                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                          keySchema +
                                                                                                                                                                                                                                                                                                                                                                                                          interface MapSchema {
                                                                                                                                                                                                                                                                                                                                                                                                              keySchema: SchemaRef;
                                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                                              namespace: string;
                                                                                                                                                                                                                                                                                                                                                                                                              traits: SchemaTraits;
                                                                                                                                                                                                                                                                                                                                                                                                              valueSchema: SchemaRef;
                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                          keySchema name namespace traits diff --git a/docs/interfaces/_internal_.MediaTypeObject.html b/docs/interfaces/_internal_.MediaTypeObject.html index 63c30b52..deaeea68 100644 --- a/docs/interfaces/_internal_.MediaTypeObject.html +++ b/docs/interfaces/_internal_.MediaTypeObject.html @@ -1,4 +1,4 @@ -MediaTypeObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                            Interface MediaTypeObject

                                                                                                                                                                                                                                                                                                                                                                                                            interface MediaTypeObject {
                                                                                                                                                                                                                                                                                                                                                                                                                encoding?: EncodingObject;
                                                                                                                                                                                                                                                                                                                                                                                                                example?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                examples?: ExamplesObject;
                                                                                                                                                                                                                                                                                                                                                                                                                schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                            • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                            encoding? +MediaTypeObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                              Interface MediaTypeObject

                                                                                                                                                                                                                                                                                                                                                                                                              interface MediaTypeObject {
                                                                                                                                                                                                                                                                                                                                                                                                                  encoding?: EncodingObject;
                                                                                                                                                                                                                                                                                                                                                                                                                  example?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                  examples?: ExamplesObject;
                                                                                                                                                                                                                                                                                                                                                                                                                  schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                  [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                              • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                              encoding? example? examples? schema? diff --git a/docs/interfaces/_internal_.MoveOperation.html b/docs/interfaces/_internal_.MoveOperation.html index 088bad70..5516db22 100644 --- a/docs/interfaces/_internal_.MoveOperation.html +++ b/docs/interfaces/_internal_.MoveOperation.html @@ -1,4 +1,4 @@ -MoveOperation | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                Interface MoveOperation

                                                                                                                                                                                                                                                                                                                                                                                                                interface MoveOperation {
                                                                                                                                                                                                                                                                                                                                                                                                                    from: string;
                                                                                                                                                                                                                                                                                                                                                                                                                    op: "move";
                                                                                                                                                                                                                                                                                                                                                                                                                    path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                from +MoveOperation | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                  Interface MoveOperation

                                                                                                                                                                                                                                                                                                                                                                                                                  interface MoveOperation {
                                                                                                                                                                                                                                                                                                                                                                                                                      from: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      op: "move";
                                                                                                                                                                                                                                                                                                                                                                                                                      path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  from op path

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  from: string
                                                                                                                                                                                                                                                                                                                                                                                                                  op: "move"
                                                                                                                                                                                                                                                                                                                                                                                                                  path: string

                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.MultipleOptionalResolvedValueMetadataInjectOptions.html b/docs/interfaces/_internal_.MultipleOptionalResolvedValueMetadataInjectOptions.html index 8bc2b72f..5d080266 100644 --- a/docs/interfaces/_internal_.MultipleOptionalResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.MultipleOptionalResolvedValueMetadataInjectOptions.html @@ -1,4 +1,4 @@ -MultipleOptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                    Interface MultipleOptionalResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                    interface MultipleOptionalResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                        chained?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                        isMultiple: true;
                                                                                                                                                                                                                                                                                                                                                                                                                        name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                        optional: true;
                                                                                                                                                                                                                                                                                                                                                                                                                        serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                        tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                    chained? +MultipleOptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                      Interface MultipleOptionalResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                      interface MultipleOptionalResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                          chained?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                          isMultiple: true;
                                                                                                                                                                                                                                                                                                                                                                                                                          name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                          optional: true;
                                                                                                                                                                                                                                                                                                                                                                                                                          serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                          tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                      chained? isMultiple name? optional diff --git a/docs/interfaces/_internal_.MultipleResolvedValueMetadataInjectOptions.html b/docs/interfaces/_internal_.MultipleResolvedValueMetadataInjectOptions.html index 58936e08..072ea37f 100644 --- a/docs/interfaces/_internal_.MultipleResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.MultipleResolvedValueMetadataInjectOptions.html @@ -1,4 +1,4 @@ -MultipleResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                        Interface MultipleResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                        interface MultipleResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                            chained?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                            isMultiple: true;
                                                                                                                                                                                                                                                                                                                                                                                                                            name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                            serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                            tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                        chained? +MultipleResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                          Interface MultipleResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                          interface MultipleResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                              chained?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                              isMultiple: true;
                                                                                                                                                                                                                                                                                                                                                                                                                              name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                              serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                              tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                          • T

                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                          chained? isMultiple name? serviceIdentifier diff --git a/docs/interfaces/_internal_.OAuthFlowObject.html b/docs/interfaces/_internal_.OAuthFlowObject.html index 24c4c110..d9e41f21 100644 --- a/docs/interfaces/_internal_.OAuthFlowObject.html +++ b/docs/interfaces/_internal_.OAuthFlowObject.html @@ -1,4 +1,4 @@ -OAuthFlowObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                            Interface OAuthFlowObject

                                                                                                                                                                                                                                                                                                                                                                                                                            interface OAuthFlowObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                authorizationUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                refreshUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                scopes: ScopesObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                tokenUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                            • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                            authorizationUrl? +OAuthFlowObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                              Interface OAuthFlowObject

                                                                                                                                                                                                                                                                                                                                                                                                                              interface OAuthFlowObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                  authorizationUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                  refreshUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                  scopes: ScopesObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                  tokenUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                  [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                              • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                              authorizationUrl? refreshUrl? scopes tokenUrl? diff --git a/docs/interfaces/_internal_.OAuthFlowsObject.html b/docs/interfaces/_internal_.OAuthFlowsObject.html index 2f0a2372..8dda06f8 100644 --- a/docs/interfaces/_internal_.OAuthFlowsObject.html +++ b/docs/interfaces/_internal_.OAuthFlowsObject.html @@ -1,4 +1,4 @@ -OAuthFlowsObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                Interface OAuthFlowsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                interface OAuthFlowsObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                    authorizationCode?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                    clientCredentials?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                    implicit?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                    password?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                    [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                authorizationCode? +OAuthFlowsObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface OAuthFlowsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                  interface OAuthFlowsObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                      authorizationCode?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                      clientCredentials?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                      implicit?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                      password?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                      [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                  • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                  authorizationCode? clientCredentials? implicit? password? diff --git a/docs/interfaces/_internal_.OpenAPIObject.html b/docs/interfaces/_internal_.OpenAPIObject.html index e3184394..99d39d6c 100644 --- a/docs/interfaces/_internal_.OpenAPIObject.html +++ b/docs/interfaces/_internal_.OpenAPIObject.html @@ -1,4 +1,4 @@ -OpenAPIObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface OpenAPIObject

                                                                                                                                                                                                                                                                                                                                                                                                                                    interface OpenAPIObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                        components?: ComponentsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                        externalDocs?: ExternalDocumentationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                        info: InfoObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                        openapi: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        paths?: PathsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                        security?: SecurityRequirementObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                        servers?: ServerObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                        tags?: TagObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                        webhooks?: PathsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                        [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                    • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                    components? +OpenAPIObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface OpenAPIObject

                                                                                                                                                                                                                                                                                                                                                                                                                                      interface OpenAPIObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                          components?: ComponentsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                          externalDocs?: ExternalDocumentationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                          info: InfoObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                          openapi: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          paths?: PathsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                          security?: SecurityRequirementObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                          servers?: ServerObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                          tags?: TagObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                          webhooks?: PathsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                          [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                      • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                      components? externalDocs? info openapi diff --git a/docs/interfaces/_internal_.OperationObject.html b/docs/interfaces/_internal_.OperationObject.html index 65ed83bd..17047475 100644 --- a/docs/interfaces/_internal_.OperationObject.html +++ b/docs/interfaces/_internal_.OperationObject.html @@ -1,4 +1,4 @@ -OperationObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface OperationObject

                                                                                                                                                                                                                                                                                                                                                                                                                                        interface OperationObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                            callbacks?: CallbacksObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                            deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                            description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            externalDocs?: ExternalDocumentationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                            operationId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            parameters?: (ReferenceObject | ParameterObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                            requestBody?: ReferenceObject | RequestBodyObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                            responses?: ResponsesObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                            security?: SecurityRequirementObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                            servers?: ServerObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                            summary?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            tags?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                            [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                        • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                        callbacks? +OperationObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface OperationObject

                                                                                                                                                                                                                                                                                                                                                                                                                                          interface OperationObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                              callbacks?: CallbacksObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                              deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              externalDocs?: ExternalDocumentationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                              operationId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              parameters?: (ReferenceObject | ParameterObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                              requestBody?: ReferenceObject | RequestBodyObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                              responses?: ResponsesObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                              security?: SecurityRequirementObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                              servers?: ServerObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                              summary?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                              tags?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                              [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                          • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                          callbacks? deprecated? description? externalDocs? diff --git a/docs/interfaces/_internal_.OptionalGetOptions.html b/docs/interfaces/_internal_.OptionalGetOptions.html index 463f95ce..9bfe0490 100644 --- a/docs/interfaces/_internal_.OptionalGetOptions.html +++ b/docs/interfaces/_internal_.OptionalGetOptions.html @@ -1,4 +1,4 @@ -OptionalGetOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface OptionalGetOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                            interface OptionalGetOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                autobind?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                optional: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                tag?: GetOptionsTagConstraint;
                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                            autobind? +OptionalGetOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface OptionalGetOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                              interface OptionalGetOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                  autobind?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  optional: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  tag?: GetOptionsTagConstraint;
                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                              autobind? name? optional tag? diff --git a/docs/interfaces/_internal_.OptionalResolvedValueMetadataInjectOptions.html b/docs/interfaces/_internal_.OptionalResolvedValueMetadataInjectOptions.html index e0502a6f..69244a71 100644 --- a/docs/interfaces/_internal_.OptionalResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.OptionalResolvedValueMetadataInjectOptions.html @@ -1,4 +1,4 @@ -OptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface OptionalResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                interface OptionalResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                    name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    optional: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                name? +OptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface OptionalResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface OptionalResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                      name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      optional: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                  name? optional serviceIdentifier tags? diff --git a/docs/interfaces/_internal_.OutgoingHttpHeaders.html b/docs/interfaces/_internal_.OutgoingHttpHeaders.html index 76f04fb3..eab9e834 100644 --- a/docs/interfaces/_internal_.OutgoingHttpHeaders.html +++ b/docs/interfaces/_internal_.OutgoingHttpHeaders.html @@ -1,4 +1,4 @@ -OutgoingHttpHeaders | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface OutgoingHttpHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface OutgoingHttpHeaders {
                                                                                                                                                                                                                                                                                                                                                                                                                                                        accept?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "accept-charset"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "accept-encoding"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "accept-language"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "accept-ranges"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-allow-credentials"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-allow-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-allow-methods"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-allow-origin"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-expose-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-max-age"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-request-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-request-method"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        age?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        allow?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        authorization?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "cache-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "cdn-cache-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        connection?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-disposition"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-language"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-length"?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-location"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-range"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-security-policy"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-security-policy-report-only"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-type"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        cookie?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        date?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        dav?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        dnt?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        etag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        expect?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        expires?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        forwarded?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        from?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "if-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "if-modified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "if-none-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "if-range"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "if-unmodified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "last-modified"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        link?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        location?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "max-forwards"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        origin?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        pragma?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "proxy-authenticate"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "proxy-authorization"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "public-key-pins"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "public-key-pins-report-only"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        range?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        referer?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "referrer-policy"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        refresh?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "retry-after"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "sec-websocket-accept"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "sec-websocket-extensions"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "sec-websocket-key"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "sec-websocket-protocol"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "sec-websocket-version"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        server?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "set-cookie"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "strict-transport-security"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        te?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        trailer?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "transfer-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        upgrade?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "upgrade-insecure-requests"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "user-agent"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        vary?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        via?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        warning?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "www-authenticate"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "x-content-type-options"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "x-dns-prefetch-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "x-frame-options"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        "x-xss-protection"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        [key: string]: OutgoingHttpHeader;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                    accept? +OutgoingHttpHeaders | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface OutgoingHttpHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface OutgoingHttpHeaders {
                                                                                                                                                                                                                                                                                                                                                                                                                                                          accept?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "accept-charset"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "accept-encoding"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "accept-language"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "accept-ranges"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-allow-credentials"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-allow-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-allow-methods"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-allow-origin"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-expose-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-max-age"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-request-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-request-method"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          age?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          allow?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          authorization?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "cache-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "cdn-cache-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          connection?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-disposition"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-language"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-length"?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-location"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-range"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-security-policy"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-security-policy-report-only"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-type"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          cookie?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                          date?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          dav?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                          dnt?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          etag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          expect?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          expires?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          forwarded?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          from?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "if-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "if-modified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "if-none-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "if-range"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "if-unmodified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "last-modified"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          link?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                          location?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "max-forwards"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          origin?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          pragma?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "proxy-authenticate"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "proxy-authorization"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "public-key-pins"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "public-key-pins-report-only"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          range?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          referer?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "referrer-policy"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          refresh?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "retry-after"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "sec-websocket-accept"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "sec-websocket-extensions"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "sec-websocket-key"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "sec-websocket-protocol"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "sec-websocket-version"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          server?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "set-cookie"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "strict-transport-security"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          te?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          trailer?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "transfer-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          upgrade?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "upgrade-insecure-requests"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "user-agent"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          vary?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          via?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                          warning?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "www-authenticate"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "x-content-type-options"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "x-dns-prefetch-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "x-frame-options"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "x-xss-protection"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          [key: string]: OutgoingHttpHeader;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                      accept? accept-charset? accept-encoding? accept-language? diff --git a/docs/interfaces/_internal_.ParameterObject.html b/docs/interfaces/_internal_.ParameterObject.html index 1649f352..21f7b613 100644 --- a/docs/interfaces/_internal_.ParameterObject.html +++ b/docs/interfaces/_internal_.ParameterObject.html @@ -1,4 +1,4 @@ -ParameterObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ParameterObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ParameterObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                            allowEmptyValue?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                            allowReserved?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                            content?: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                            deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                            description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                            example?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                            examples?: { [param: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                            explode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                            in: ParameterLocation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                            name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                            required?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                            schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                            style?: ParameterStyle;
                                                                                                                                                                                                                                                                                                                                                                                                                                                            [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowEmptyValue? +ParameterObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ParameterObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ParameterObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                              allowEmptyValue?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              allowReserved?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              content?: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              example?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              examples?: { [param: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                              explode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              in: ParameterLocation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              required?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              style?: ParameterStyle;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                          allowEmptyValue? allowReserved? content? deprecated? diff --git a/docs/interfaces/_internal_.Parsed-1.html b/docs/interfaces/_internal_.Parsed-1.html index 0a89f4ca..5cb7f362 100644 --- a/docs/interfaces/_internal_.Parsed-1.html +++ b/docs/interfaces/_internal_.Parsed-1.html @@ -1,4 +1,4 @@ -Parsed | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface Parsed

                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface Parsed {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                anchor?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                format?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                minFractionDigits?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                source: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                srcToken?: FlowScalar | BlockScalar;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                type?: Type;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                value: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                clone(): NodeBase;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                toJSON(arg?: any, ctx?: ToJSContext): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                toString(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                            [NODE_TYPE] +Parsed | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface Parsed

                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface Parsed {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  anchor?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  format?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minFractionDigits?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  source: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  srcToken?: FlowScalar | BlockScalar;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type?: Type;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  clone(): NodeBase;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  toJSON(arg?: any, ctx?: ToJSContext): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  toString(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                              [NODE_TYPE] addToJSMap? anchor? comment? diff --git a/docs/interfaces/_internal_.Parsed-2.html b/docs/interfaces/_internal_.Parsed-2.html index 609baa75..a70fe398 100644 --- a/docs/interfaces/_internal_.Parsed-2.html +++ b/docs/interfaces/_internal_.Parsed-2.html @@ -1,4 +1,4 @@ -Parsed | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface Parsed<K, V>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface Parsed<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    K extends ParsedNode = ParsedNode,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    V extends ParsedNode | null = ParsedNode | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                > {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    anchor?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    flow?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    items: Pair<K, V>[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    schema: Schema;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    srcToken?: BlockMap | FlowCollection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    add(pair: Pair<K, V> | { key: K; value: V }, overwrite?: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    clone(schema?: Schema): Collection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    delete(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    get(key: unknown, keepScalar: true): Scalar<V>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    get(key: unknown, keepScalar?: false): V;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    get(key: unknown, keepScalar?: boolean): V | Scalar<V>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getIn(path: Iterable<unknown>, keepScalar?: boolean): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    has(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hasAllNullValues(allowScalar?: boolean): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hasIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    set(key: K, value: V): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toJSON<T extends MapLike = Map<unknown, unknown>>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _?: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ctx?: ToJSContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type?: new () => T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toString(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ctx?: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                [NODE_TYPE] +Parsed | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface Parsed<K, V>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface Parsed<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      K extends ParsedNode = ParsedNode,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      V extends ParsedNode | null = ParsedNode | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  > {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      anchor?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      flow?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      items: Pair<K, V>[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      schema: Schema;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      srcToken?: BlockMap | FlowCollection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      add(pair: Pair<K, V> | { key: K; value: V }, overwrite?: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      addIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      clone(schema?: Schema): Collection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      delete(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      get(key: unknown, keepScalar: true): Scalar<V>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      get(key: unknown, keepScalar?: false): V;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      get(key: unknown, keepScalar?: boolean): V | Scalar<V>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getIn(path: Iterable<unknown>, keepScalar?: boolean): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      has(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hasAllNullValues(allowScalar?: boolean): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hasIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      set(key: K, value: V): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      toJSON<T extends MapLike = Map<unknown, unknown>>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          _?: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ctx?: ToJSContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type?: new () => T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      toString(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ctx?: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [NODE_TYPE] addToJSMap? anchor? comment? diff --git a/docs/interfaces/_internal_.Parsed-3.html b/docs/interfaces/_internal_.Parsed-3.html index 81081db7..c3f0e685 100644 --- a/docs/interfaces/_internal_.Parsed-3.html +++ b/docs/interfaces/_internal_.Parsed-3.html @@ -1,4 +1,4 @@ -Parsed | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface Parsed<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface Parsed<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        T extends ParsedNode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Pair<ParsedNode, ParsedNode | null> = ParsedNode,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    > {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        anchor?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        flow?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        items: T[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        schema: Schema;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        srcToken?: BlockSequence | FlowCollection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        add(value: T): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        addIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clone(schema?: Schema): Collection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        delete(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        get(key: unknown, keepScalar: true): Scalar<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        get(key: unknown, keepScalar?: false): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        get(key: unknown, keepScalar?: boolean): T | Scalar<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getIn(path: Iterable<unknown>, keepScalar?: boolean): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        has(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hasAllNullValues(allowScalar?: boolean): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hasIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        set(key: unknown, value: T): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        toJSON(_?: unknown, ctx?: ToJSContext): unknown[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        toString(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ctx?: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [NODE_TYPE] +Parsed | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface Parsed<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface Parsed<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          T extends ParsedNode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Pair<ParsedNode, ParsedNode | null> = ParsedNode,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      > {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          anchor?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          flow?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          items: T[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          schema: Schema;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          srcToken?: BlockSequence | FlowCollection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          add(value: T): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          addIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clone(schema?: Schema): Collection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          delete(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          get(key: unknown, keepScalar: true): Scalar<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          get(key: unknown, keepScalar?: false): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          get(key: unknown, keepScalar?: boolean): T | Scalar<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getIn(path: Iterable<unknown>, keepScalar?: boolean): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          has(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hasAllNullValues(allowScalar?: boolean): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hasIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          set(key: unknown, value: T): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          setIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          toJSON(_?: unknown, ctx?: ToJSContext): unknown[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          toString(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ctx?: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [NODE_TYPE] addToJSMap? anchor? comment? diff --git a/docs/interfaces/_internal_.Parsed.html b/docs/interfaces/_internal_.Parsed.html index e954bc31..59b6e6dc 100644 --- a/docs/interfaces/_internal_.Parsed.html +++ b/docs/interfaces/_internal_.Parsed.html @@ -1,4 +1,4 @@ -Parsed | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface Parsed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface Parsed {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            anchor?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            source: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            srcToken?: FlowScalar & { type: "alias" };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            clone(): NodeBase;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resolve(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                doc: Document,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ctx?: ToJSContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Scalar<unknown> | YAMLMap<unknown, unknown> | YAMLSeq<unknown>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            toJSON(_arg?: unknown, ctx?: ToJSContext): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            toString(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ctx?: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                _onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                _onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [NODE_TYPE] +Parsed | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface Parsed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface Parsed {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              anchor?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              source: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              srcToken?: FlowScalar & { type: "alias" };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              clone(): NodeBase;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resolve(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  doc: Document,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ctx?: ToJSContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Scalar<unknown> | YAMLMap<unknown, unknown> | YAMLSeq<unknown>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              toJSON(_arg?: unknown, ctx?: ToJSContext): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              toString(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ctx?: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  _onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  _onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [NODE_TYPE] addToJSMap? anchor? comment? diff --git a/docs/interfaces/_internal_.PathItemObject.html b/docs/interfaces/_internal_.PathItemObject.html index 7407d373..b2fcd461 100644 --- a/docs/interfaces/_internal_.PathItemObject.html +++ b/docs/interfaces/_internal_.PathItemObject.html @@ -1,4 +1,4 @@ -PathItemObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface PathItemObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface PathItemObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                $ref?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                delete?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                get?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                head?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                options?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                parameters?: (ReferenceObject | ParameterObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                patch?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                post?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                put?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                servers?: ServerObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                summary?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                trace?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            $ref? +PathItemObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface PathItemObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface PathItemObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  $ref?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  delete?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  get?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  head?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  parameters?: (ReferenceObject | ParameterObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  patch?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  post?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  put?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  servers?: ServerObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  summary?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  trace?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              $ref? delete? description? get? diff --git a/docs/interfaces/_internal_.PathsObject.html b/docs/interfaces/_internal_.PathsObject.html index 8fd64480..09654862 100644 --- a/docs/interfaces/_internal_.PathsObject.html +++ b/docs/interfaces/_internal_.PathsObject.html @@ -1 +1 @@ -PathsObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface PathsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +PathsObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface PathsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.PeerCertificate.html b/docs/interfaces/_internal_.PeerCertificate.html index 036a4372..0ef69c82 100644 --- a/docs/interfaces/_internal_.PeerCertificate.html +++ b/docs/interfaces/_internal_.PeerCertificate.html @@ -1,4 +1,4 @@ -PeerCertificate | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface PeerCertificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface PeerCertificate {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        asn1Curve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bits?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ca: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exponent?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ext_key_usage?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fingerprint: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fingerprint256: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fingerprint512: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        infoAccess?: Dict<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        issuer: Certificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        modulus?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        nistCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pubkey?: NonSharedBuffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        raw: NonSharedBuffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serialNumber: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        subject: Certificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        subjectaltname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        valid_from: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        valid_to: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    asn1Curve? +PeerCertificate | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface PeerCertificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface PeerCertificate {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          asn1Curve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          bits?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ca: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exponent?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ext_key_usage?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fingerprint: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fingerprint256: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fingerprint512: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          infoAccess?: Dict<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          issuer: Certificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          modulus?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          nistCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pubkey?: NonSharedBuffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          raw: NonSharedBuffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          serialNumber: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          subject: Certificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          subjectaltname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          valid_from: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          valid_to: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      asn1Curve? bits? ca exponent? diff --git a/docs/interfaces/_internal_.ProcessEnv.html b/docs/interfaces/_internal_.ProcessEnv.html index 7b69255a..38c75505 100644 --- a/docs/interfaces/_internal_.ProcessEnv.html +++ b/docs/interfaces/_internal_.ProcessEnv.html @@ -1,3 +1,3 @@ -ProcessEnv | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ProcessEnv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ProcessEnv {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            TZ?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [key: string]: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [key: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TZ? +ProcessEnv | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ProcessEnv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ProcessEnv {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              TZ?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [key: string]: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [key: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TZ?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TZ?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Can be used to change the default timezone at runtime

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.ProxyEnv.html b/docs/interfaces/_internal_.ProxyEnv.html index 4a7f64af..9ac1be86 100644 --- a/docs/interfaces/_internal_.ProxyEnv.html +++ b/docs/interfaces/_internal_.ProxyEnv.html @@ -1,4 +1,4 @@ -ProxyEnv | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ProxyEnv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ProxyEnv {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                http_proxy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                HTTP_PROXY?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                https_proxy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                HTTPS_PROXY?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                no_proxy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                NO_PROXY?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                TZ?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [key: string]: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [key: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            http_proxy? +ProxyEnv | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface ProxyEnv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface ProxyEnv {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  http_proxy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  HTTP_PROXY?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  https_proxy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  HTTPS_PROXY?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  no_proxy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  NO_PROXY?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  TZ?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [key: string]: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [key: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              http_proxy? HTTP_PROXY? https_proxy? HTTPS_PROXY? diff --git a/docs/interfaces/_internal_.ReadWriteStream.html b/docs/interfaces/_internal_.ReadWriteStream.html index ca079555..6417019a 100644 --- a/docs/interfaces/_internal_.ReadWriteStream.html +++ b/docs/interfaces/_internal_.ReadWriteStream.html @@ -1,4 +1,4 @@ -ReadWriteStream | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface ReadWriteStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface ReadWriteStream {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    writable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "[asyncIterator]"(): AsyncIterableIterator<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Buffer<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    >;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "[captureRejectionSymbol]"?<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        event: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ...args: AnyRest,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    emit<K>(eventName: string | symbol, ...args: AnyRest): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    end(cb?: () => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    end(data: string | Uint8Array<ArrayBufferLike>, cb?: () => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    end(str: string, encoding?: BufferEncoding, cb?: () => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    eventNames(): (string | symbol)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getMaxListeners(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    isPaused(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    listenerCount<K>(eventName: string | symbol, listener?: Function): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    listeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    off<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    on<K>(eventName: string | symbol, listener: (...args: any[]) => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    once<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pause(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pipe<T extends WritableStream>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        destination: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: { end?: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prependListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prependOnceListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rawListeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    read(size?: number): string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    removeAllListeners(eventName?: string | symbol): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    removeListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resume(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setEncoding(encoding: BufferEncoding): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setMaxListeners(n: number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    unpipe(destination?: WritableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    unshift(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        chunk: string | Uint8Array<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        encoding?: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    wrap(oldStream: ReadableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    write(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        buffer: string | Uint8Array<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cb?: (err?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    write(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        str: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        encoding?: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cb?: (err?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readable +ReadWriteStream | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface ReadWriteStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface ReadWriteStream {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      writable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "[asyncIterator]"(): AsyncIterableIterator<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Buffer<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      >;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "[captureRejectionSymbol]"?<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          event: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ...args: AnyRest,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      addListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      emit<K>(eventName: string | symbol, ...args: AnyRest): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      end(cb?: () => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      end(data: string | Uint8Array<ArrayBufferLike>, cb?: () => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      end(str: string, encoding?: BufferEncoding, cb?: () => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      eventNames(): (string | symbol)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getMaxListeners(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      isPaused(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      listenerCount<K>(eventName: string | symbol, listener?: Function): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      listeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      off<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      on<K>(eventName: string | symbol, listener: (...args: any[]) => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      once<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pause(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pipe<T extends WritableStream>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          destination: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: { end?: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      prependListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      prependOnceListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      rawListeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      read(size?: number): string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      removeAllListeners(eventName?: string | symbol): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      removeListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resume(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setEncoding(encoding: BufferEncoding): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setMaxListeners(n: number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      unpipe(destination?: WritableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      unshift(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          chunk: string | Uint8Array<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          encoding?: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      wrap(oldStream: ReadableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      write(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          buffer: string | Uint8Array<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cb?: (err?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      write(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          str: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          encoding?: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cb?: (err?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readable writable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [asyncIterator] [captureRejectionSymbol]? diff --git a/docs/interfaces/_internal_.ReadableStream.html b/docs/interfaces/_internal_.ReadableStream.html index 34364cab..d4dc8eec 100644 --- a/docs/interfaces/_internal_.ReadableStream.html +++ b/docs/interfaces/_internal_.ReadableStream.html @@ -1,4 +1,4 @@ -ReadableStream | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface ReadableStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface ReadableStream {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "[asyncIterator]"(): AsyncIterableIterator<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        >;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "[captureRejectionSymbol]"?<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            event: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ...args: AnyRest,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        addListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        emit<K>(eventName: string | symbol, ...args: AnyRest): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventNames(): (string | symbol)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getMaxListeners(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isPaused(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listenerCount<K>(eventName: string | symbol, listener?: Function): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        off<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        on<K>(eventName: string | symbol, listener: (...args: any[]) => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        once<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pause(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pipe<T extends WritableStream>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            destination: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: { end?: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        prependListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        prependOnceListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rawListeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        read(size?: number): string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        removeAllListeners(eventName?: string | symbol): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        removeListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        resume(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setEncoding(encoding: BufferEncoding): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setMaxListeners(n: number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        unpipe(destination?: WritableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        unshift(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            chunk: string | Uint8Array<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            encoding?: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        wrap(oldStream: ReadableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readable +ReadableStream | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface ReadableStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface ReadableStream {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[asyncIterator]"(): AsyncIterableIterator<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Buffer<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          >;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[captureRejectionSymbol]"?<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              event: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ...args: AnyRest,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          addListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          emit<K>(eventName: string | symbol, ...args: AnyRest): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventNames(): (string | symbol)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getMaxListeners(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isPaused(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listenerCount<K>(eventName: string | symbol, listener?: Function): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          off<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          on<K>(eventName: string | symbol, listener: (...args: any[]) => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          once<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pause(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pipe<T extends WritableStream>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              destination: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: { end?: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          prependListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          prependOnceListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          rawListeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          read(size?: number): string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          removeAllListeners(eventName?: string | symbol): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          removeListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          resume(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          setEncoding(encoding: BufferEncoding): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          setMaxListeners(n: number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          unpipe(destination?: WritableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          unshift(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              chunk: string | Uint8Array<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              encoding?: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          wrap(oldStream: ReadableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [asyncIterator] [captureRejectionSymbol]? addListener diff --git a/docs/interfaces/_internal_.ReadableStreamAsyncIterator.html b/docs/interfaces/_internal_.ReadableStreamAsyncIterator.html index 43348cca..d6ce4d52 100644 --- a/docs/interfaces/_internal_.ReadableStreamAsyncIterator.html +++ b/docs/interfaces/_internal_.ReadableStreamAsyncIterator.html @@ -1,4 +1,4 @@ -ReadableStreamAsyncIterator | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ReadableStreamAsyncIterator<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ReadableStreamAsyncIterator<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[asyncDispose]"(): PromiseLike<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[asyncIterator]"(): ReadableStreamAsyncIterator<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            next(...__namedParameters: [] | [unknown]): Promise<IteratorResult<T, any>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            return?(value?: any): Promise<IteratorResult<T, any>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throw?(e?: any): Promise<IteratorResult<T, any>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [asyncDispose] +ReadableStreamAsyncIterator | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ReadableStreamAsyncIterator<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ReadableStreamAsyncIterator<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "[asyncDispose]"(): PromiseLike<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "[asyncIterator]"(): ReadableStreamAsyncIterator<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              next(...__namedParameters: [] | [unknown]): Promise<IteratorResult<T, any>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              return?(value?: any): Promise<IteratorResult<T, any>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              throw?(e?: any): Promise<IteratorResult<T, any>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [asyncDispose] [asyncIterator] next return? diff --git a/docs/interfaces/_internal_.ReadableStreamBYOBReader.html b/docs/interfaces/_internal_.ReadableStreamBYOBReader.html index 976bf518..b3de6fbf 100644 --- a/docs/interfaces/_internal_.ReadableStreamBYOBReader.html +++ b/docs/interfaces/_internal_.ReadableStreamBYOBReader.html @@ -1,5 +1,5 @@ ReadableStreamBYOBReader | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ReadableStreamBYOBReader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            MDN Reference

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ReadableStreamBYOBReader {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                closed: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cancel(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                read<T extends ArrayBufferView<ArrayBufferLike>>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    view: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: { min?: number },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ReadableStreamReadResult<T>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                releaseLock(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            closed +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ReadableStreamBYOBReader {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                closed: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cancel(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                read<T extends ArrayBufferView<ArrayBufferLike>>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    view: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: { min?: number },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ReadableStreamReadResult<T>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                releaseLock(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            closed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cancel read releaseLock diff --git a/docs/interfaces/_internal_.ReadableStreamDefaultReader.html b/docs/interfaces/_internal_.ReadableStreamDefaultReader.html index 6c9f710e..06ad9bfd 100644 --- a/docs/interfaces/_internal_.ReadableStreamDefaultReader.html +++ b/docs/interfaces/_internal_.ReadableStreamDefaultReader.html @@ -1,4 +1,4 @@ -ReadableStreamDefaultReader | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface ReadableStreamDefaultReader<R>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface ReadableStreamDefaultReader<R = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  closed: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cancel(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  read(): Promise<ReadableStreamReadResult<R>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  releaseLock(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • R = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              closed +ReadableStreamDefaultReader | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface ReadableStreamDefaultReader<R>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface ReadableStreamDefaultReader<R = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    closed: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cancel(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    read(): Promise<ReadableStreamReadResult<R>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    releaseLock(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • R = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                closed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cancel read releaseLock diff --git a/docs/interfaces/_internal_.ReadableStreamGenericReader.html b/docs/interfaces/_internal_.ReadableStreamGenericReader.html index ea716104..4f5e871d 100644 --- a/docs/interfaces/_internal_.ReadableStreamGenericReader.html +++ b/docs/interfaces/_internal_.ReadableStreamGenericReader.html @@ -1,3 +1,3 @@ -ReadableStreamGenericReader | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface ReadableStreamGenericReader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface ReadableStreamGenericReader {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      closed: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cancel(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  closed +ReadableStreamGenericReader | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface ReadableStreamGenericReader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface ReadableStreamGenericReader {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        closed: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cancel(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    closed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cancel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    closed: Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.RemoveOperation.html b/docs/interfaces/_internal_.RemoveOperation.html index fd24091c..60bcb375 100644 --- a/docs/interfaces/_internal_.RemoveOperation.html +++ b/docs/interfaces/_internal_.RemoveOperation.html @@ -1,3 +1,3 @@ -RemoveOperation | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface RemoveOperation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface RemoveOperation {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          op: "remove";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      op +RemoveOperation | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface RemoveOperation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface RemoveOperation {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            op: "remove";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        op path

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        op: "remove"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.ReplaceOperation.html b/docs/interfaces/_internal_.ReplaceOperation.html index 0e655722..8e9f1aaf 100644 --- a/docs/interfaces/_internal_.ReplaceOperation.html +++ b/docs/interfaces/_internal_.ReplaceOperation.html @@ -1,4 +1,4 @@ -ReplaceOperation | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ReplaceOperation<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ReplaceOperation<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              op: "replace";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              value: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          op +ReplaceOperation | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ReplaceOperation<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ReplaceOperation<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                op: "replace";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                value: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            op path value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            op: "replace"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            path: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            value: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.RequestBodyObject.html b/docs/interfaces/_internal_.RequestBodyObject.html index 53ce6ccf..bae707e3 100644 --- a/docs/interfaces/_internal_.RequestBodyObject.html +++ b/docs/interfaces/_internal_.RequestBodyObject.html @@ -1,4 +1,4 @@ -RequestBodyObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface RequestBodyObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface RequestBodyObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  content: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  required?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              content +RequestBodyObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface RequestBodyObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface RequestBodyObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    content: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    required?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                content description? required?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                content

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                content: ContentObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                required?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.RequestOptions-1.html b/docs/interfaces/_internal_.RequestOptions-1.html index 73136990..690d570b 100644 --- a/docs/interfaces/_internal_.RequestOptions-1.html +++ b/docs/interfaces/_internal_.RequestOptions-1.html @@ -1,5 +1,5 @@ RequestOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface RequestOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  From T, pick a set of properties whose keys are in the union K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface RequestOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      _defaultAgent?: Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      agent?: boolean | Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      auth?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createConnection?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: ClientRequestArgs,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          oncreate: (err: Error, socket: Duplex) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => Duplex;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      defaultPort?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      headers?: readonly string[] | OutgoingHttpHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hostname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      insecureHTTPParser?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      joinDuplicateHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      maxHeaderSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      method?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      port?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setDefaultHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setHost?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      socketPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      uniqueHeaders?: (string | string[])[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  _defaultAgent? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface RequestOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      _defaultAgent?: Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      agent?: boolean | Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      auth?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createConnection?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: ClientRequestArgs,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          oncreate: (err: Error, socket: Duplex) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => Duplex;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      defaultPort?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      headers?: readonly string[] | OutgoingHttpHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hostname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      insecureHTTPParser?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      joinDuplicateHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      maxHeaderSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      method?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      port?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setDefaultHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setHost?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      socketPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      uniqueHeaders?: (string | string[])[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  _defaultAgent? agent? auth? createConnection? diff --git a/docs/interfaces/_internal_.RequestOptions.html b/docs/interfaces/_internal_.RequestOptions.html index 84e95596..141cacef 100644 --- a/docs/interfaces/_internal_.RequestOptions.html +++ b/docs/interfaces/_internal_.RequestOptions.html @@ -1,5 +1,5 @@ RequestOptions | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface RequestOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    From T, pick a set of properties whose keys are in the union K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface RequestOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _defaultAgent?: Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        agent?: boolean | Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowPartialTrustChain?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        auth?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ca?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cert?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        checkServerIdentity?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            hostname: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cert: DetailedPeerCertificate,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => Error;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ciphers?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientCertEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createConnection?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options: ClientRequestArgs,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            oncreate: (err: Error, socket: Duplex) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => Duplex;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        crl?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultPort?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        dhparam?: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ecdhCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        headers?: readonly string[] | OutgoingHttpHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        honorCipherOrder?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hostname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        insecureHTTPParser?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        joinDuplicateHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike> | KeyObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxHeaderSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        method?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        minVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        passphrase?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike> | PxfObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        port?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        privateKeyEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        privateKeyIdentifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rejectUnauthorized?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secureOptions?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secureProtocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        servername?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sessionIdContext?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sessionTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setDefaultHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setHost?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sigalgs?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        socketPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ticketKeys?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        uniqueHeaders?: (string | string[])[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _defaultAgent? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface RequestOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _defaultAgent?: Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        agent?: boolean | Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowPartialTrustChain?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        auth?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ca?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cert?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        checkServerIdentity?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            hostname: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cert: DetailedPeerCertificate,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => Error;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ciphers?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientCertEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createConnection?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options: ClientRequestArgs,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            oncreate: (err: Error, socket: Duplex) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => Duplex;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        crl?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultPort?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        dhparam?: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ecdhCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        headers?: readonly string[] | OutgoingHttpHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        honorCipherOrder?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hostname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        insecureHTTPParser?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        joinDuplicateHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike> | KeyObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxHeaderSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        method?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        minVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        passphrase?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike> | PxfObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        port?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        privateKeyEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        privateKeyIdentifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rejectUnauthorized?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secureOptions?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secureProtocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        servername?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sessionIdContext?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sessionTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setDefaultHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setHost?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sigalgs?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        socketPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ticketKeys?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        uniqueHeaders?: (string | string[])[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _defaultAgent? agent? allowPartialTrustChain? ALPNCallback? diff --git a/docs/interfaces/_internal_.RequestSigningArguments.html b/docs/interfaces/_internal_.RequestSigningArguments.html index f742c94e..9b17475f 100644 --- a/docs/interfaces/_internal_.RequestSigningArguments.html +++ b/docs/interfaces/_internal_.RequestSigningArguments.html @@ -1,4 +1,4 @@ -RequestSigningArguments | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface RequestSigningArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface RequestSigningArguments {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signableHeaders?: Set<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingDate?: DateInput;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingRegion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingService?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          unsignableHeaders?: Set<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signableHeaders? +RequestSigningArguments | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface RequestSigningArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface RequestSigningArguments {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signableHeaders?: Set<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signingDate?: DateInput;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signingRegion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signingService?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            unsignableHeaders?: Set<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signableHeaders? signingDate? signingRegion? signingService? diff --git a/docs/interfaces/_internal_.ResponseObject.html b/docs/interfaces/_internal_.ResponseObject.html index 29d5cf18..660d8b16 100644 --- a/docs/interfaces/_internal_.ResponseObject.html +++ b/docs/interfaces/_internal_.ResponseObject.html @@ -1,4 +1,4 @@ -ResponseObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ResponseObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ResponseObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              content?: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              headers?: HeadersObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              links?: LinksObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          content? +ResponseObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ResponseObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ResponseObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                content?: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                headers?: HeadersObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                links?: LinksObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            content? description headers? links? diff --git a/docs/interfaces/_internal_.ResponsesObject.html b/docs/interfaces/_internal_.ResponsesObject.html index ec294dec..62c26438 100644 --- a/docs/interfaces/_internal_.ResponsesObject.html +++ b/docs/interfaces/_internal_.ResponsesObject.html @@ -1,2 +1,2 @@ -ResponsesObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface ResponsesObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface ResponsesObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  default?: ReferenceObject | ResponseObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [statuscode: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [statuscode: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              default? +ResponsesObject | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface ResponsesObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface ResponsesObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    default?: ReferenceObject | ResponseObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [statuscode: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [statuscode: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                default?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                default?: ReferenceObject | ResponseObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.RetryStrategyConfiguration.html b/docs/interfaces/_internal_.RetryStrategyConfiguration.html index 95091f03..c1419b6d 100644 --- a/docs/interfaces/_internal_.RetryStrategyConfiguration.html +++ b/docs/interfaces/_internal_.RetryStrategyConfiguration.html @@ -1,5 +1,5 @@ RetryStrategyConfiguration | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface RetryStrategyConfigurationInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A configuration interface with methods called by runtime extension

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface RetryStrategyConfiguration {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      retryStrategy(): Provider<RetryStrategy | RetryStrategyV2>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setRetryStrategy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          retryStrategy: Provider<RetryStrategy | RetryStrategyV2>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  retryStrategy +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface RetryStrategyConfiguration {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      retryStrategy(): Provider<RetryStrategy | RetryStrategyV2>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setRetryStrategy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          retryStrategy: Provider<RetryStrategy | RetryStrategyV2>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  retryStrategy setRetryStrategy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns ApiApp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  apiServer: Server
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  appConfig: AppConfig = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  (Optional) Application config to pass to lambda-api, defaults to new AppConfig.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  appContainer: Container = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  (Optional) InversifyJS IOC Container instance which can +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns ApiApp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  apiServer: Server
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  appConfig: AppConfig = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  (Optional) Application config to pass to lambda-api, defaults to new AppConfig.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  appContainer: 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. If you pass your own instance autoInjectionEnabled must reflect the autobind flag passed to the Container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  autoInjectionEnabled: boolean = true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  (Optional) Is auto injection enabled in the IOC container? Defaults to true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  controllersPath?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  (Optional) Paths to the directories that contain controller js files that +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  autoInjectionEnabled: boolean = true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  (Optional) Is auto injection enabled in the IOC container? Defaults to true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  controllersPath?: string[]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  initialised: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logFactory: LogFactory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logger: ILogger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Configure the API instance from the lambda-api package.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  initialised: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logFactory: LogFactory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  logger: ILogger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Configure the API instance from the lambda-api package.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • configureBlock: (this: void, api: API) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function that takes an API instance as a parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Configure the InversifyJS IOC Container instance.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Configure the InversifyJS IOC Container instance.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • configureBlock: (this: void, container: Container) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function that takes a Container instance as a parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Initialise all controllers and endpoints declared using decorators.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Initialise all controllers and endpoints declared using decorators.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Accessors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Accessors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/classes/ApiError.html b/docs/classes/ApiError.html index a68d4a92..437b9d3f 100644 --- a/docs/classes/ApiError.html +++ b/docs/classes/ApiError.html @@ -1,6 +1,6 @@ ApiError | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Class ApiError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Context of an error thrown by an endpoint method.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Instances of this class are passed to error interceptors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constructor +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    endpointController endpointMethod endpointMethodParameters @@ -8,9 +8,9 @@ request response

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    endpointController: Controller

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Controller instance used to call endpoint method.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    endpointMethod: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Endpoint method defintion.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    endpointMethodParameters: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameter values passed to the endpoint method.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    error: Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Error thrown by the endpoint method.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    request: Request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HTTP request context.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    response: Response

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HTTP response context.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    endpointMethod: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Endpoint method defintion.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    endpointMethodParameters: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameter values passed to the endpoint method.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    error: Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Error thrown by the endpoint method.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    request: Request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HTTP request context.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    response: Response

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    HTTP response context.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/classes/ApiLambdaApp.html b/docs/classes/ApiLambdaApp.html index 2ab0be14..b85eaab6 100644 --- a/docs/classes/ApiLambdaApp.html +++ b/docs/classes/ApiLambdaApp.html @@ -2,7 +2,7 @@ AWS Lambda requests and can be used to provide a Lambda function handler.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The run method is the function handler entrypoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    apiServer appConfig appContainer @@ -14,6 +14,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    middlewareRegistry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    configureApi configureApp +createHandler initialiseControllers run

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Create a new lambda app.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -26,23 +27,26 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • 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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns ApiLambdaApp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    apiServer: Server
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    appConfig: AppConfig = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    (Optional) Application config to pass to lambda-api, defaults to new AppConfig.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    appContainer: Container = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    (Optional) InversifyJS IOC Container instance which can +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns ApiLambdaApp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    apiServer: Server
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    appConfig: AppConfig = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    (Optional) Application config to pass to lambda-api, defaults to new AppConfig.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    appContainer: 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. If you pass your own instance autoInjectionEnabled must reflect the autobind flag passed to the Container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    autoInjectionEnabled: boolean = true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    (Optional) Is auto injection enabled in the IOC container? Defaults to true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    controllersPath?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    (Optional) Paths to the directories that contain controller js files that +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    autoInjectionEnabled: boolean = true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    (Optional) Is auto injection enabled in the IOC container? Defaults to true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    controllersPath?: string[]

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    initialised: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    logFactory: LogFactory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    logger: ILogger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    initialised: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    logFactory: LogFactory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    logger: ILogger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Configure the API instance from the lambda-api package.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • configureBlock: (this: void, api: API) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function that takes an API instance as a parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Configure the InversifyJS IOC Container instance.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Configure the InversifyJS IOC Container instance.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • configureBlock: (this: void, container: Container) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function that takes a Container instance as a parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Accessors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Accessors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/classes/ApiRequest.html b/docs/classes/ApiRequest.html index 5b3f1ce8..ba96ed05 100644 --- a/docs/classes/ApiRequest.html +++ b/docs/classes/ApiRequest.html @@ -1,7 +1,7 @@ ApiRequest | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Class ApiRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      AWS Lambda HTTP request event. Used for testing, enabling manually passing requests to a ApiLambdaApp instance.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constructor +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      body headers httpMethod @@ -9,9 +9,9 @@ path queryStringParameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      body

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      body: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HTTP request event body, potentially Base64 encoded.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      headers: object = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HTTP request headers as a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpMethod: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HTTP method ('GET', 'POST', 'PUT' etc.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      isBase64Encoded: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Is the body property Base64 encoded?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      path: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Request URL path. Excludes protocol, host and port.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      queryStringParameters: object = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HTTP request query string parameters as a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      headers: object = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HTTP request headers as a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpMethod: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HTTP method ('GET', 'POST', 'PUT' etc.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      isBase64Encoded: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Is the body property Base64 encoded?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      path: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Request URL path. Excludes protocol, host and port.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      queryStringParameters: object = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      HTTP request query string parameters as a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/classes/ApiResponse.html b/docs/classes/ApiResponse.html index 7e95fa3d..3e5b0e93 100644 --- a/docs/classes/ApiResponse.html +++ b/docs/classes/ApiResponse.html @@ -1,11 +1,11 @@ ApiResponse | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Class ApiResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Response to aAWS Lambda HTTP request event. Used for testing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        body headers isBase64Encoded statusCode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        body

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        body: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        HTTP response body, potentially Base64 encoded.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        headers: object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        HTTP response headers as a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isBase64Encoded: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Is the body property Base64 encoded?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        statusCode: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        HTTP response code (201, 400, 500 etc.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        headers: object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        HTTP response headers as a map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isBase64Encoded: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Is the body property Base64 encoded?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        statusCode: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        HTTP response code (201, 400, 500 etc.)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/classes/AppConfig.html b/docs/classes/AppConfig.html index 6e5078bf..a11c92df 100644 --- a/docs/classes/AppConfig.html +++ b/docs/classes/AppConfig.html @@ -4,7 +4,7 @@ register it with the application IOC container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This class supports all the lambda-api config options by implementing the Options interface.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        base? callbackName? logger? @@ -14,24 +14,24 @@ serializer? serverLogger? version? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        base?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Base path for all routes, e.g. base: 'v1' would +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        base?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Base path for all routes, e.g. base: 'v1' would prefix all routes with /v1.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callbackName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Override the default callback query parameter name +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callbackName?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Override the default callback query parameter name for JSONP calls.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        logger?: boolean | LoggerOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        lambda-api logging configuration. Enables/disables default logging +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        logger?: boolean | LoggerOptions

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        mimeTypes?: { [key: string]: string }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name/value pairs of additional MIME types to be supported +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        mimeTypes?: { [key: string]: string }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name/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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        API human readable name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        openApi?: OpenApiConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        OpenAPI configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serializer?: SerializerFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional object serializer function. This function receives the +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        API human readable name.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        openApi?: OpenApiConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        OpenAPI configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serializer?: SerializerFunction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Optional object serializer function. This function receives the body of a response and must return a string. Defaults to JSON.stringify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serverLogger?: ServerLoggerConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Logging configuration for ts-lambda-api. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serverLogger?: ServerLoggerConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Logging configuration for ts-lambda-api. See [[ServerLoggerConfig]] for more information.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Defaults to info level plain string logging.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        version?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Version number accessible via Request context instances.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        version?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Version number accessible via Request context instances.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/classes/BasicAuth.html b/docs/classes/BasicAuth.html index c147b4fa..6022bb99 100644 --- a/docs/classes/BasicAuth.html +++ b/docs/classes/BasicAuth.html @@ -1,6 +1,6 @@ BasicAuth | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Class BasicAuth

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Basic authentication details extracted from a request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constructor +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          password username -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          password: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          username: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          password: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          username: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/classes/BasicAuthFilter.html b/docs/classes/BasicAuthFilter.html index 1f706e9c..e40b8103 100644 --- a/docs/classes/BasicAuthFilter.html +++ b/docs/classes/BasicAuthFilter.html @@ -1,5 +1,5 @@ BasicAuthFilter | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Class BasicAuthFilter<T>Abstract

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            IAuthFilter implementation that supports the HTTP Basic authentication scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            authenticationSchemeName name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            authenticate @@ -7,8 +7,8 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            authenticationSchemeName: string = "Basic"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            String to use in WWW-Authenticate header when returing a HTTP 401 response, see: https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A human readable name for this authentication filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A human readable name for this authentication filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<BasicAuth>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/classes/Controller.html b/docs/classes/Controller.html index 63fabcd4..1e5d22a6 100644 --- a/docs/classes/Controller.html +++ b/docs/classes/Controller.html @@ -1,7 +1,7 @@ Controller | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Class ControllerAbstract

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Base class for API controllers. Provides access to the current HTTP context as protected fields, and convenience method for applying JSON patches.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              _logger request response @@ -10,11 +10,11 @@ setRequest setResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Protected_logger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              _logger: ILogger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Logger instance for this controller.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              request: Request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The current HTTP request context.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              response: Response

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The current HTTP response context.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              request: Request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The current HTTP request context.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              response: Response

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The current HTTP response context.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Apply a set of JSON patch operations to an object instance.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The type of object to be patched.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • patch: JsonPatch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The operations to apply.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • obj: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The object instance to apply operations to.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/classes/ErrorInterceptor.html b/docs/classes/ErrorInterceptor.html index 985043fc..73cebf30 100644 --- a/docs/classes/ErrorInterceptor.html +++ b/docs/classes/ErrorInterceptor.html @@ -1,19 +1,19 @@ ErrorInterceptor | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Class ErrorInterceptorAbstract

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Base class for implementing error interceptors that are invoked to handle errors thrown by endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constructor +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                controllerTarget? endpointTarget?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                intercept shouldIntercept -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                controllerTarget?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                endpointTarget?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Error interceptors implement this method to handle errors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                controllerTarget?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                endpointTarget?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Error interceptors implement this method to handle errors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • apiError: ApiError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Details of error that was thrown by an endpoint, contains the request and response context, which can used to return a custom HTTP response.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Value that you want to send back in the HTTP response; optional.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Should this interceptor handle a given endpoint error?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • controller: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Class name of the controller where the error occurred.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • endpoint: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Name of the endpoint; format is ${ClassName}:${MethodName}.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/classes/LogFactory.html b/docs/classes/LogFactory.html index 704140d7..d8ab80ff 100644 --- a/docs/classes/LogFactory.html +++ b/docs/classes/LogFactory.html @@ -1,5 +1,5 @@ LogFactory | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Class LogFactory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Builds implementations of [[ILogger]].

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  constructor +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getLogger getCustomLogger getDefaultLogger @@ -9,14 +9,14 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • logFormat: LogFormat = "string"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  (Optional) Format to output log messages in, defaults to string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • logTimestamp: boolean = false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  (Optional) Print an ISO 8601 timestamp before every log message? (string format only, defaults to false).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns LogFactory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Create a new logger.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns LogFactory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Create a new logger using custom log configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns ILogger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Create a new logger using custom log configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • clazz: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The enclosing class that will use the new logger.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • level: LogLevel = LogLevel.info

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      (Optional) Lowest level to log, defaults to info.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • format: LogFormat = "string"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      (Optional) Format to output log messages in, defaults to string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • logTimestamp: boolean = false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      (Optional) Print an ISO 8601 timestamp before every log message? (string format only, defaults to false).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns ILogger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Create a new logger using [[AppConfig]] config defaults.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns ILogger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns ILogger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/classes/MiddlewareRegistry.html b/docs/classes/MiddlewareRegistry.html index 734e5022..679cd279 100644 --- a/docs/classes/MiddlewareRegistry.html +++ b/docs/classes/MiddlewareRegistry.html @@ -1,28 +1,28 @@ MiddlewareRegistry | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Class MiddlewareRegistry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Holds all the middleware that will be applied to incoming HTTP requests before or after calling endpoint methods.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constructor +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    authFilters authorizers errorInterceptors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addAuthFilter addAuthorizer addErrorInterceptor -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • get authFilters(): IAuthFilter<any, Principal>[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Authentication filters to apply. These are chained, meaning only +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Accessors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Accessors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/classes/OpenApiConfig.html b/docs/classes/OpenApiConfig.html index cb8c852d..10842f6e 100644 --- a/docs/classes/OpenApiConfig.html +++ b/docs/classes/OpenApiConfig.html @@ -1,8 +1,8 @@ -OpenApiConfig | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Class OpenApiConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constructor +OpenApiConfig | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Class OpenApiConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        enabled? useAuthentication?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        enabled?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set this flag to true to enable OpenAPI endpoints in your API @ {basePath}/open-api.json and {basePath}/open-api.yml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useAuthentication?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set this flag to apply any registered authentication +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useAuthentication?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Set this flag to apply any registered authentication filters to OpenAPI spec requests.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/classes/Principal.html b/docs/classes/Principal.html index 49826176..58c90704 100644 --- a/docs/classes/Principal.html +++ b/docs/classes/Principal.html @@ -2,9 +2,9 @@ by an authentication filter upon successful request authentication.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Extend this class to define a custom principal.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Protected_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Accessors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Principal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Protected_name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Accessors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/classes/RequestBuilder.html b/docs/classes/RequestBuilder.html index f0074d42..302325a2 100644 --- a/docs/classes/RequestBuilder.html +++ b/docs/classes/RequestBuilder.html @@ -1,6 +1,6 @@ RequestBuilder | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Class RequestBuilder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Builds ApiRequest instances using the builder pattern. Used for testing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          base64EncodedBody +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          base64EncodedBody basicAuth binaryBody body @@ -18,42 +18,42 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          body

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          body

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns RequestBuilder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns RequestBuilder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Start building a HTTP PATCH request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns RequestBuilder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Staticpost

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • post(path: string): RequestBuilder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Start building a HTTP POST request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns RequestBuilder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Staticpost

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns RequestBuilder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns RequestBuilder

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/classes/Server.html b/docs/classes/Server.html index ddb01e99..b2c3a9b2 100644 --- a/docs/classes/Server.html +++ b/docs/classes/Server.html @@ -1,7 +1,7 @@ Server | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Class Server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Server that discovers routes using decorators on controller classes and methods. Processing of requests is preformed by the lambda-api package.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            middlewareRegistry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            configure discoverAndBuildRoutes @@ -10,10 +10,10 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • appContainer: Container

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Application container to use to build containers.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • autoInjectionEnabled: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Is autobind flag enabled on IOC container.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • appConfig: AppConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Application config to pass to lambda-api.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Configure the API instance from the lambda-api +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Server

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Configure the API instance from the lambda-api package.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • handler: (this: void, api: API) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function that takes an API instance as a parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Scans the specified path for javascript files and loads these into +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Takes an API request passed in by AWS Lambda and processes +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Accessors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Accessors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/classes/ServerLoggerConfig.html b/docs/classes/ServerLoggerConfig.html index c002420a..a8336e46 100644 --- a/docs/classes/ServerLoggerConfig.html +++ b/docs/classes/ServerLoggerConfig.html @@ -1,5 +1,5 @@ ServerLoggerConfig | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Class ServerLoggerConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Logging configuration for the ts-lambda-api framework.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              format? level logTimestamp? @@ -15,9 +15,9 @@ 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "level": "INFO",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "msg": "Endpoint - Invoking endpoint: [GET] /open-api.yml",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "time": 1555865906882 // millis since epoch
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              level: LogLevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Lowest level of log message to output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              level: LogLevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Lowest level of log message to output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              See [[LogLevel]] for levels supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              logTimestamp?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Print an ISO 8601 timestamp before every log message? (string format only)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              logTimestamp?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/classes/_internal_.Agent-1.html b/docs/classes/_internal_.Agent-1.html index 124feb9a..30391af5 100644 --- a/docs/classes/_internal_.Agent-1.html +++ b/docs/classes/_internal_.Agent-1.html @@ -6,7 +6,7 @@ for details on overriding this method, including asynchronous socket creation with a callback.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v0.4.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              freeSockets maxFreeSockets maxSockets diff --git a/docs/classes/_internal_.Agent.html b/docs/classes/_internal_.Agent.html index 0e2faab3..7080652a 100644 --- a/docs/classes/_internal_.Agent.html +++ b/docs/classes/_internal_.Agent.html @@ -37,7 +37,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              v0.3.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              freeSockets maxFreeSockets maxSockets diff --git a/docs/classes/_internal_.Alias.html b/docs/classes/_internal_.Alias.html index 46ae9f71..79640c94 100644 --- a/docs/classes/_internal_.Alias.html +++ b/docs/classes/_internal_.Alias.html @@ -1,4 +1,4 @@ -Alias | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Class Alias

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constructor +Alias | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Class Alias

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [NODE_TYPE] addToJSMap? anchor? diff --git a/docs/classes/_internal_.ApiBody.html b/docs/classes/_internal_.ApiBody.html index a6eb9a80..4029e3a6 100644 --- a/docs/classes/_internal_.ApiBody.html +++ b/docs/classes/_internal_.ApiBody.html @@ -1,5 +1,5 @@ ApiBody | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Class ApiBody

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Describes the body of a HTTP request or response.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    class? contentType? description? @@ -8,13 +8,13 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    class?: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Class type that the content will store. This will generate a schema in the OpenAPI spec for the given type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    contentType?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Content (MIME) type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Description of this HTTP body.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    example?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Free form example of this body in plain +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    contentType?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Content (MIME) type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Description of this HTTP body.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    example?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Free form example of this body in plain text. Setting this will prevent type or class from setting auto-generated examples.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type of data the content stores, one of the following:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type?: string

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/classes/_internal_.ApiBodyInfo.html b/docs/classes/_internal_.ApiBodyInfo.html index f4fc4cd5..21ffbd17 100644 --- a/docs/classes/_internal_.ApiBodyInfo.html +++ b/docs/classes/_internal_.ApiBodyInfo.html @@ -1,5 +1,5 @@ ApiBodyInfo | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Class ApiBodyInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Describes the body of a HTTP request or response.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      class? contentType? description? @@ -9,13 +9,13 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      class?: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Class type that the content will store. This will generate a schema in the OpenAPI spec for the given type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      contentType?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Content (MIME) type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      description?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Description of this HTTP body.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      example?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Free form example of this body in plain +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      contentType?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Content (MIME) type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      description?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Description of this HTTP body.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      example?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Free form example of this body in plain text. Setting this will prevent type or class from setting auto-generated examples.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type of data the content stores, one of the following:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type?: string

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/classes/_internal_.ApiOperation.html b/docs/classes/_internal_.ApiOperation.html index 1b9230c8..7b9c6996 100644 --- a/docs/classes/_internal_.ApiOperation.html +++ b/docs/classes/_internal_.ApiOperation.html @@ -1,14 +1,14 @@ ApiOperation | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Class ApiOperation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Describes an API endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description? name? request? responses?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Description of the endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name of the endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        request?: ApiBodyInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Information about the endpoint request body.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        responses?: IDictionary<ApiBodyInfo> = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Map of HTTP status codes (as strings) to response +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Name of the endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        request?: ApiBodyInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Information about the endpoint request body.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        responses?: IDictionary<ApiBodyInfo> = {}

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/classes/_internal_.ApiOperationInfo.html b/docs/classes/_internal_.ApiOperationInfo.html index 48626c18..93daf20d 100644 --- a/docs/classes/_internal_.ApiOperationInfo.html +++ b/docs/classes/_internal_.ApiOperationInfo.html @@ -1,5 +1,5 @@ ApiOperationInfo | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Class ApiOperationInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Describes an API endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description? name? request? @@ -8,14 +8,14 @@ mergeInfo mergeResponses

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Description of the endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name of the endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          request?: ApiBodyInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Information about the endpoint request body.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          responses?: IDictionary<ApiBodyInfo> = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Map of HTTP status codes (as strings) to response +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Name of the endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          request?: ApiBodyInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Information about the endpoint request body.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          responses?: IDictionary<ApiBodyInfo> = {}

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/classes/_internal_.ApiParam.html b/docs/classes/_internal_.ApiParam.html index fb92ac99..0bac897c 100644 --- a/docs/classes/_internal_.ApiParam.html +++ b/docs/classes/_internal_.ApiParam.html @@ -1,5 +1,5 @@ ApiParam | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Class ApiParam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Describes a parameter in a HTTP request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            class? contentType? description? @@ -11,23 +11,23 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            class?: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Class type that the content will store. This will generate a schema in the OpenAPI spec for the given type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            contentType?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Content (MIME) type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Description of this HTTP body.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            example?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Free form example of this body in plain +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            contentType?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Content (MIME) type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Description of this HTTP body.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            example?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Free form example of this body in plain text. Setting this will prevent type or class from setting auto-generated examples.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            explode?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Specifies whether arrays and objects should generate +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            explode?: boolean

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See: https://swagger.io/docs/specification/serialization/

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            required?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Is this parameter required in requests?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            style?: ParameterStyle

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Defines how array/object is delimited. Possible styles +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            required?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Is this parameter required in requests?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            style?: ParameterStyle

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Defines how array/object is delimited. Possible styles depend on the parameter location.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See: https://swagger.io/docs/specification/serialization/

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type of data the content stores, one of the following:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type?: string

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/classes/_internal_.AsyncResource.html b/docs/classes/_internal_.AsyncResource.html index 51f770a3..d63383f7 100644 --- a/docs/classes/_internal_.AsyncResource.html +++ b/docs/classes/_internal_.AsyncResource.html @@ -6,7 +6,7 @@ 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            import { AsyncResource, executionAsyncId } from 'node:async_hooks';

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // AsyncResource() is meant to be extended. Instantiating a
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // new AsyncResource() also triggers init. If triggerAsyncId is omitted then
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // async_hook.executionAsyncId() is used.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            const asyncResource = new AsyncResource(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type, { triggerAsyncId: executionAsyncId(), requireManualDestroy: false },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            );

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Run a function in the execution context of the resource. This will
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // * establish the context of the resource
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // * trigger the AsyncHooks before callbacks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // * call the provided function `fn` with the supplied arguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // * trigger the AsyncHooks after callbacks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // * restore the original execution context
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            asyncResource.runInAsyncScope(fn, thisArg, ...args);

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Call AsyncHooks destroy callbacks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            asyncResource.emitDestroy();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Return the unique ID assigned to the AsyncResource instance.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            asyncResource.asyncId();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            // Return the trigger ID for the AsyncResource instance.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            asyncResource.triggerAsyncId();
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            asyncId bind emitDestroy diff --git a/docs/classes/_internal_.AuthFilterInfo.html b/docs/classes/_internal_.AuthFilterInfo.html index ae87bf08..4ead9bff 100644 --- a/docs/classes/_internal_.AuthFilterInfo.html +++ b/docs/classes/_internal_.AuthFilterInfo.html @@ -1,4 +1,4 @@ -AuthFilterInfo | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Class AuthFilterInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor +AuthFilterInfo | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Class AuthFilterInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name? securitySchemeInfo? -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                securitySchemeInfo?: SecuritySchemeObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                securitySchemeInfo?: SecuritySchemeObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/classes/_internal_.ClientRequest.html b/docs/classes/_internal_.ClientRequest.html index 2ab07305..f02f9b27 100644 --- a/docs/classes/_internal_.ClientRequest.html +++ b/docs/classes/_internal_.ClientRequest.html @@ -21,7 +21,7 @@ identified by code:``'ERR_HTTP_CONTENT_LENGTH_MISMATCH'.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Content-Length value should be in bytes, not characters. Use Buffer.byteLength() to determine the length of the body in bytes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v0.1.17

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                aborted chunkedEncoding closed diff --git a/docs/classes/_internal_.Collection.html b/docs/classes/_internal_.Collection.html index 341f1e62..a1315c7d 100644 --- a/docs/classes/_internal_.Collection.html +++ b/docs/classes/_internal_.Collection.html @@ -1,4 +1,4 @@ -Collection | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Class CollectionAbstract

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  constructor +Collection | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Class CollectionAbstract

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [NODE_TYPE] addToJSMap? anchor? diff --git a/docs/classes/_internal_.ControllerInfo.html b/docs/classes/_internal_.ControllerInfo.html index 0853762b..6d7f4c90 100644 --- a/docs/classes/_internal_.ControllerInfo.html +++ b/docs/classes/_internal_.ControllerInfo.html @@ -1,4 +1,4 @@ -ControllerInfo | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Class ControllerInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constructor +ControllerInfo | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Class ControllerInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiDescription? apiIgnore? apiName? @@ -13,4 +13,4 @@ produces? rolesAllowed?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getOrCreateRequestInfo -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiDescription?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiIgnore?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiName?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiRequestInfo?: ApiBodyInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        classConstructor: Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        consumes?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        endpoints: Map<string, EndpointInfo> = ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        errorInterceptor?: ServiceIdentifier<ErrorInterceptor>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        noAuth?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        produces?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rolesAllowed?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiDescription?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiIgnore?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiName?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiRequestInfo?: ApiBodyInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        classConstructor: Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        consumes?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        endpoints: Map<string, EndpointInfo> = ...
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        errorInterceptor?: ServiceIdentifier<ErrorInterceptor>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        noAuth?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        produces?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rolesAllowed?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/classes/_internal_.Document.html b/docs/classes/_internal_.Document.html index 1bf254cb..c2a0f0e9 100644 --- a/docs/classes/_internal_.Document.html +++ b/docs/classes/_internal_.Document.html @@ -1,4 +1,4 @@ -Document | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Class Document<Contents, Strict>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Contents extends Node = Node
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Strict extends boolean = true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constructor +Document | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Class Document<Contents, Strict>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Contents extends Node = Node
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Strict extends boolean = true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [NODE_TYPE] comment commentBefore diff --git a/docs/classes/_internal_.EndpointInfo.html b/docs/classes/_internal_.EndpointInfo.html index de4514fd..05d793b3 100644 --- a/docs/classes/_internal_.EndpointInfo.html +++ b/docs/classes/_internal_.EndpointInfo.html @@ -1,4 +1,4 @@ -EndpointInfo | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Class EndpointInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor +EndpointInfo | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Class EndpointInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                apiIgnore? apiOperationInfo? consumes? @@ -22,4 +22,4 @@ roles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getControllerPropOrDefault getOrCreateApiOperationInfo -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                apiIgnore?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                apiOperationInfo?: ApiOperationInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                consumes?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                controller?: ControllerInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                errorInterceptor?: ServiceIdentifier<ErrorInterceptor>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                httpMethod: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                method: Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                methodName?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                noAuth?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                parameterExtractors: IParameterExtractor[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                path?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                produces?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                rolesAllowed?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Accessors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                apiIgnore?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                apiOperationInfo?: ApiOperationInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                consumes?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                controller?: ControllerInfo
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                errorInterceptor?: ServiceIdentifier<ErrorInterceptor>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                httpMethod: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                method: Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                methodName?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                noAuth?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                parameterExtractors: IParameterExtractor[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                path?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                produces?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                rolesAllowed?: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Accessors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Accessors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/classes/_internal_.EventEmitter.EventEmitterAsyncResource.html b/docs/classes/_internal_.EventEmitter.EventEmitterAsyncResource.html index 2206ed29..f3a8c826 100644 --- a/docs/classes/_internal_.EventEmitter.EventEmitterAsyncResource.html +++ b/docs/classes/_internal_.EventEmitter.EventEmitterAsyncResource.html @@ -7,7 +7,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                The EventEmitterAsyncResource class has the same methods and takes the same options as EventEmitter and AsyncResource themselves.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v17.4.0, v16.14.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                asyncId asyncResource triggerAsyncId diff --git a/docs/classes/_internal_.EventEmitter.html b/docs/classes/_internal_.EventEmitter.html index 53a3c73c..e4b26b46 100644 --- a/docs/classes/_internal_.EventEmitter.html +++ b/docs/classes/_internal_.EventEmitter.html @@ -6,7 +6,7 @@ added and 'removeListener' when existing listeners are removed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                It supports the following option:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                captureRejections captureRejectionSymbol defaultMaxListeners diff --git a/docs/classes/_internal_.HttpRequest.html b/docs/classes/_internal_.HttpRequest.html index 8222b094..4a43a998 100644 --- a/docs/classes/_internal_.HttpRequest.html +++ b/docs/classes/_internal_.HttpRequest.html @@ -1,4 +1,4 @@ -HttpRequest | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Class HttpRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  constructor +HttpRequest | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Class HttpRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    body? fragment? headers diff --git a/docs/classes/_internal_.HttpResponse.html b/docs/classes/_internal_.HttpResponse.html index b414c813..ff5356cd 100644 --- a/docs/classes/_internal_.HttpResponse.html +++ b/docs/classes/_internal_.HttpResponse.html @@ -1,4 +1,4 @@ -HttpResponse | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Class HttpResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constructor +HttpResponse | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Class HttpResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        body? headers reason? diff --git a/docs/classes/_internal_.IncomingMessage.html b/docs/classes/_internal_.IncomingMessage.html index 5fecf722..38279023 100644 --- a/docs/classes/_internal_.IncomingMessage.html +++ b/docs/classes/_internal_.IncomingMessage.html @@ -5,7 +5,7 @@ parse and emit the incoming HTTP headers and payload, as the underlying socket may be reused multiple times in case of keep-alive.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        v0.1.17

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        aborted closed complete diff --git a/docs/classes/_internal_.NodeBase.html b/docs/classes/_internal_.NodeBase.html index 882ef9c8..61b45269 100644 --- a/docs/classes/_internal_.NodeBase.html +++ b/docs/classes/_internal_.NodeBase.html @@ -1,4 +1,4 @@ -NodeBase | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Class NodeBaseAbstract

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constructor +NodeBase | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Class NodeBaseAbstract

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [NODE_TYPE] addToJSMap? comment? diff --git a/docs/classes/_internal_.OpenApiGenerator.html b/docs/classes/_internal_.OpenApiGenerator.html index 1b122f0a..89f2bce6 100644 --- a/docs/classes/_internal_.OpenApiGenerator.html +++ b/docs/classes/_internal_.OpenApiGenerator.html @@ -1,4 +1,4 @@ -OpenApiGenerator | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Class OpenApiGenerator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor +OpenApiGenerator | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Class OpenApiGenerator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                buildOpenApiSpec exportOpenApiSpec -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/classes/_internal_.OutgoingMessage.html b/docs/classes/_internal_.OutgoingMessage.html index 9cd57e8d..0c167899 100644 --- a/docs/classes/_internal_.OutgoingMessage.html +++ b/docs/classes/_internal_.OutgoingMessage.html @@ -1,7 +1,7 @@ OutgoingMessage | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Class OutgoingMessage<Request>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  v0.1.17

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  chunkedEncoding closed connection diff --git a/docs/classes/_internal_.Readable.html b/docs/classes/_internal_.Readable.html index 3f19a232..b0c01cf4 100644 --- a/docs/classes/_internal_.Readable.html +++ b/docs/classes/_internal_.Readable.html @@ -1,5 +1,5 @@ Readable | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Class Readable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v0.9.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    closed destroyed errored diff --git a/docs/classes/_internal_.Scalar.html b/docs/classes/_internal_.Scalar.html index 04297e75..e204157a 100644 --- a/docs/classes/_internal_.Scalar.html +++ b/docs/classes/_internal_.Scalar.html @@ -1,4 +1,4 @@ -Scalar | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Class Scalar<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T = unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constructor +Scalar | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Class Scalar<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T = unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [NODE_TYPE] addToJSMap? anchor? diff --git a/docs/classes/_internal_.Socket.html b/docs/classes/_internal_.Socket.html index 6b10c27e..fe0f5c9f 100644 --- a/docs/classes/_internal_.Socket.html +++ b/docs/classes/_internal_.Socket.html @@ -8,7 +8,7 @@ is received. For example, it is passed to the listeners of a 'connection' event emitted on a Server, so the user can use it to interact with the client.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        v0.3.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowHalfOpen autoSelectFamilyAttemptedAddresses bufferSize diff --git a/docs/classes/_internal_.Stream.Duplex.html b/docs/classes/_internal_.Stream.Duplex.html index 9b1c12e5..ee497a47 100644 --- a/docs/classes/_internal_.Stream.Duplex.html +++ b/docs/classes/_internal_.Stream.Duplex.html @@ -6,7 +6,7 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • crypto streams

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • v0.9.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowHalfOpen closed destroyed diff --git a/docs/classes/_internal_.Stream.PassThrough.html b/docs/classes/_internal_.Stream.PassThrough.html index bba6ac5e..b4278535 100644 --- a/docs/classes/_internal_.Stream.PassThrough.html +++ b/docs/classes/_internal_.Stream.PassThrough.html @@ -1,6 +1,6 @@ PassThrough | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Class PassThrough

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allowHalfOpen closed destroyed diff --git a/docs/classes/_internal_.Stream.Transform.html b/docs/classes/_internal_.Stream.Transform.html index a7baf697..99feb8d1 100644 --- a/docs/classes/_internal_.Stream.Transform.html +++ b/docs/classes/_internal_.Stream.Transform.html @@ -7,7 +7,7 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • crypto streams

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • v0.9.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allowHalfOpen closed destroyed diff --git a/docs/classes/_internal_.Stream.Writable.html b/docs/classes/_internal_.Stream.Writable.html index cbc5d2bb..9fcc2c5b 100644 --- a/docs/classes/_internal_.Stream.Writable.html +++ b/docs/classes/_internal_.Stream.Writable.html @@ -1,5 +1,5 @@ Writable | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Class Writable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v0.9.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Implements

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            closed destroyed errored diff --git a/docs/classes/_internal_.Stream.html b/docs/classes/_internal_.Stream.html index 3c8138fc..3f4b6d5e 100644 --- a/docs/classes/_internal_.Stream.html +++ b/docs/classes/_internal_.Stream.html @@ -6,7 +6,7 @@ added and 'removeListener' when existing listeners are removed.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            It supports the following option:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v0.1.26

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            captureRejections captureRejectionSymbol defaultMaxListeners diff --git a/docs/classes/_internal_.URL.html b/docs/classes/_internal_.URL.html index b24780cb..1ba3a37f 100644 --- a/docs/classes/_internal_.URL.html +++ b/docs/classes/_internal_.URL.html @@ -7,7 +7,7 @@ using the delete keyword on any properties of URL objects (e.g. delete myURL.protocol, delete myURL.pathname, etc) has no effect but will still return true.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            v7.0.0, v6.13.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            hash host hostname diff --git a/docs/classes/_internal_.YAMLError.html b/docs/classes/_internal_.YAMLError.html index d43146d1..ec43794c 100644 --- a/docs/classes/_internal_.YAMLError.html +++ b/docs/classes/_internal_.YAMLError.html @@ -1,4 +1,4 @@ -YAMLError | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Class YAMLError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constructor +YAMLError | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Class YAMLError

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cause? code linePos? diff --git a/docs/classes/_internal_.YAMLMap.html b/docs/classes/_internal_.YAMLMap.html index f7c8629a..ae5b63e6 100644 --- a/docs/classes/_internal_.YAMLMap.html +++ b/docs/classes/_internal_.YAMLMap.html @@ -1,4 +1,4 @@ -YAMLMap | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Class YAMLMap<K, V>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • K = unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • V = unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  constructor +YAMLMap | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Class YAMLMap<K, V>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • K = unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • V = unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [NODE_TYPE] addToJSMap? anchor? diff --git a/docs/classes/_internal_.YAMLSeq.html b/docs/classes/_internal_.YAMLSeq.html index e78220e3..94d70e8b 100644 --- a/docs/classes/_internal_.YAMLSeq.html +++ b/docs/classes/_internal_.YAMLSeq.html @@ -1,4 +1,4 @@ -YAMLSeq | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Class YAMLSeq<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T = unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constructor +YAMLSeq | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Class YAMLSeq<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T = unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [NODE_TYPE] addToJSMap? anchor? diff --git a/docs/classes/_internal_.YAMLWarning.html b/docs/classes/_internal_.YAMLWarning.html index 120be3a3..75375940 100644 --- a/docs/classes/_internal_.YAMLWarning.html +++ b/docs/classes/_internal_.YAMLWarning.html @@ -1,4 +1,4 @@ -YAMLWarning | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Class YAMLWarning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constructor +YAMLWarning | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Class YAMLWarning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Constructors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            constructor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cause? code linePos? diff --git a/docs/enums/LogLevel.html b/docs/enums/LogLevel.html index 8511e13e..ca9d97e3 100644 --- a/docs/enums/LogLevel.html +++ b/docs/enums/LogLevel.html @@ -1,8 +1,8 @@ -LogLevel | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Enumeration LogLevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Enumeration Members

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              debug +LogLevel | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Enumeration LogLevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Enumeration Members

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                debug error fatal info off trace warn -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Enumeration Members

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                debug: 20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                error: 50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                fatal: 60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                info: 30
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                off: 70
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                trace: 10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                warn: 40

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Enumeration Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Enumeration Members

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                debug: 20
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                error: 50
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                fatal: 60
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                info: 30
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                off: 70
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                trace: 10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                warn: 40

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Enumeration Members
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/DELETE.html b/docs/functions/DELETE.html index 8d87b7be..81611708 100644 --- a/docs/functions/DELETE.html +++ b/docs/functions/DELETE.html @@ -3,4 +3,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • path: string = ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/GET.html b/docs/functions/GET.html index 9ec64884..ae254cf3 100644 --- a/docs/functions/GET.html +++ b/docs/functions/GET.html @@ -3,4 +3,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • path: string = ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/PATCH.html b/docs/functions/PATCH.html index cb6eef39..080c9821 100644 --- a/docs/functions/PATCH.html +++ b/docs/functions/PATCH.html @@ -3,4 +3,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • path: string = ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/POST.html b/docs/functions/POST.html index 03bd4fdd..8299d409 100644 --- a/docs/functions/POST.html +++ b/docs/functions/POST.html @@ -3,4 +3,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • path: string = ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/PUT.html b/docs/functions/PUT.html index d6ae48aa..004b61f5 100644 --- a/docs/functions/PUT.html +++ b/docs/functions/PUT.html @@ -3,4 +3,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • path: string = ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/api.html b/docs/functions/api.html index 83f832ba..48e0719e 100644 --- a/docs/functions/api.html +++ b/docs/functions/api.html @@ -1,4 +1,4 @@ api | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function api

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Decorator for a controller class to describe it in any generated OpenAPI specification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Name of the API used to categorise endpoints in this controller.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionaldescription: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns (classDefinition: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionaldescription: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns (classDefinition: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/functions/apiController.html b/docs/functions/apiController.html index 07f52533..fc65691b 100644 --- a/docs/functions/apiController.html +++ b/docs/functions/apiController.html @@ -1,4 +1,4 @@ apiController | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function apiController

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Decorator that can be placed on a class to mark it is an API controller.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalpath: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A root URL path that all endpoints in this controller share; optional. This URL can contain path parameters, prefixed with a colon (':') character.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns (constructor: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns (constructor: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/apiIgnore.html b/docs/functions/apiIgnore.html index 33ba0f4b..d011a825 100644 --- a/docs/functions/apiIgnore.html +++ b/docs/functions/apiIgnore.html @@ -1,3 +1,3 @@ apiIgnore | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function apiIgnore

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Decorator that can be placed on an endpoint method to exclude it from any generated OpenAPI specification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/apiIgnoreController.html b/docs/functions/apiIgnoreController.html index 35f5ebc5..02441f03 100644 --- a/docs/functions/apiIgnoreController.html +++ b/docs/functions/apiIgnoreController.html @@ -1,3 +1,3 @@ apiIgnoreController | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function apiIgnoreController

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns (classDefinition: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/apiOperation.html b/docs/functions/apiOperation.html index b66cf359..a6e3b97f 100644 --- a/docs/functions/apiOperation.html +++ b/docs/functions/apiOperation.html @@ -3,4 +3,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • apiOperationInfo: ApiOperation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Information about this api operation; will be merged with existing info if present, replacing any existing properties, if provided in this parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/apiRequest.html b/docs/functions/apiRequest.html index 309fa589..d301a2e6 100644 --- a/docs/functions/apiRequest.html +++ b/docs/functions/apiRequest.html @@ -1,4 +1,4 @@ apiRequest | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function apiRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Decorator that can be placed on an endpoint to describe the request in any generated OpenAPI specification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • apiBodyInfo: ApiBody

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Request body info.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns (classDefinition: object | Function, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns (classDefinition: object | Function, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/apiResponse.html b/docs/functions/apiResponse.html index 8d641ff9..b230db61 100644 --- a/docs/functions/apiResponse.html +++ b/docs/functions/apiResponse.html @@ -2,4 +2,4 @@ in any generated OpenAPI specification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • statusCode: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            HTTP status code that will be sent in this response.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OptionalapiBodyInfo: ApiBody

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Information about the response body generated.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns (classDefinition: object, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/apiSecurity.html b/docs/functions/apiSecurity.html index feec8e68..06d462bc 100644 --- a/docs/functions/apiSecurity.html +++ b/docs/functions/apiSecurity.html @@ -2,4 +2,4 @@ OpenAPI specification as a security scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Name of the API security scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • securitySchemeInfo: SecuritySchemeObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            openapi3-ts security scheme model.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns (classDefinition: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns (classDefinition: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/body.html b/docs/functions/body.html index 11af32fa..c17ad529 100644 --- a/docs/functions/body.html +++ b/docs/functions/body.html @@ -1,4 +1,4 @@ body | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function body

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • body(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  classDefinition: object | Function,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  methodName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  paramIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/consumes.html b/docs/functions/consumes.html index ddb26c9d..f112188d 100644 --- a/docs/functions/consumes.html +++ b/docs/functions/consumes.html @@ -1,4 +1,4 @@ consumes | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function consumes

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • OptionalcontentType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Request content type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • OptionalapiBodyInfo: ApiBody

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns (classDefinition: object | Function, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalapiBodyInfo: ApiBody

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns (classDefinition: object | Function, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/controllerConsumes.html b/docs/functions/controllerConsumes.html index f88fdbe7..0972f45a 100644 --- a/docs/functions/controllerConsumes.html +++ b/docs/functions/controllerConsumes.html @@ -1,4 +1,4 @@ controllerConsumes | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function controllerConsumes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Decorator for a controller class that details the HTTP request Content-Type header value for all endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • contentType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Request content type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • OptionalapiBodyInfo: ApiBody

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns (classDefinition: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • OptionalapiBodyInfo: ApiBody

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns (classDefinition: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/controllerErrorInterceptor.html b/docs/functions/controllerErrorInterceptor.html index 983d3cbc..bd7ad3fc 100644 --- a/docs/functions/controllerErrorInterceptor.html +++ b/docs/functions/controllerErrorInterceptor.html @@ -1,3 +1,3 @@ controllerErrorInterceptor | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function controllerErrorInterceptor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns (classDefinition: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/functions/controllerNoAuth.html b/docs/functions/controllerNoAuth.html index 7e10acd3..dfd4e6f2 100644 --- a/docs/functions/controllerNoAuth.html +++ b/docs/functions/controllerNoAuth.html @@ -1,2 +1,2 @@ controllerNoAuth | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function controllerNoAuth

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Decorator for a controller class that marks it not requiring authentication for any of it's endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • classDefinition: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • classDefinition: Function

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/controllerProduces.html b/docs/functions/controllerProduces.html index 4b8dbe2a..5fd0291d 100644 --- a/docs/functions/controllerProduces.html +++ b/docs/functions/controllerProduces.html @@ -1,4 +1,4 @@ controllerProduces | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function controllerProduces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Decorator for a controller class that sets the HTTP response Content-Type header value for all endpoints.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • contentType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Content-Type header value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns (classDefinition: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns (classDefinition: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/controllerRolesAllowed.html b/docs/functions/controllerRolesAllowed.html index 8cf2591e..0fa5f1e0 100644 --- a/docs/functions/controllerRolesAllowed.html +++ b/docs/functions/controllerRolesAllowed.html @@ -3,4 +3,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Role based authorization is managed by a IAuthorizer implementation registered with the current app.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ...roleNames: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Names of roles that are permitted to use the endpoints in this controller.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns (classDefinition: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns (classDefinition: Function) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/errorInterceptor.html b/docs/functions/errorInterceptor.html index 499c542c..6265753e 100644 --- a/docs/functions/errorInterceptor.html +++ b/docs/functions/errorInterceptor.html @@ -1,4 +1,4 @@ errorInterceptor | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function errorInterceptor

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns (classDefinition: object | Function, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns (classDefinition: object | Function, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/header.html b/docs/functions/header.html index b37cbb03..b9d23836 100644 --- a/docs/functions/header.html +++ b/docs/functions/header.html @@ -1,4 +1,4 @@ header | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Function header

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Decorator which injects a HTTP request header as a parameter value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Value passed to the method will be a string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • headerName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The name of the header to inject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalapiParamInfo: ApiParam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                classDefinition: object | Function,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                methodName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                paramIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalapiParamInfo: ApiParam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              classDefinition: object | Function,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              methodName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              paramIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/functions/noAuth.html b/docs/functions/noAuth.html index e3aa836c..464ee332 100644 --- a/docs/functions/noAuth.html +++ b/docs/functions/noAuth.html @@ -1,2 +1,2 @@ noAuth | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Function noAuth

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Decorator for an endpoint method that marks it as not requiring authentication.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • methodName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • methodName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/pathParam.html b/docs/functions/pathParam.html index c6ddc76a..3f0dad02 100644 --- a/docs/functions/pathParam.html +++ b/docs/functions/pathParam.html @@ -2,4 +2,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Value passed to the method will be a string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • paramName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              The name of the path parameter to inject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalapiParamInfo: ApiParam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              (Optional) OpenApi metadata about the path parameter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                classDefinition: object | Function,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                methodName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                paramIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                classDefinition: object | Function,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                methodName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                paramIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/functions/principal.html b/docs/functions/principal.html index 066b19a8..b0623475 100644 --- a/docs/functions/principal.html +++ b/docs/functions/principal.html @@ -1,3 +1,3 @@ principal | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Function principal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Decorator which injects the current authentication principal as a parameter value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Value passed to the method will be an implementation of the Principal interface.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/functions/produces.html b/docs/functions/produces.html index 09608e69..29c426a6 100644 --- a/docs/functions/produces.html +++ b/docs/functions/produces.html @@ -1,4 +1,4 @@ produces | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Function produces

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • contentType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Content-Type header value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns (classDefinition: object | Function, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns (classDefinition: object | Function, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/functions/queryParam.html b/docs/functions/queryParam.html index a9966dc5..757a81c6 100644 --- a/docs/functions/queryParam.html +++ b/docs/functions/queryParam.html @@ -1,4 +1,4 @@ queryParam | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Function queryParam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Decorator which injects a query parameter value as an endpoint parameter value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Value passed to the method will be a string.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • paramName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The name of the query parameter to inject.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalapiParamInfo: ApiParam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        classDefinition: object | Function,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        methodName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        paramIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • OptionalapiParamInfo: ApiParam

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Returns (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      classDefinition: object | Function,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      methodName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      paramIndex: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/functions/rawBody.html b/docs/functions/rawBody.html index ff1aed3a..b9408224 100644 --- a/docs/functions/rawBody.html +++ b/docs/functions/rawBody.html @@ -1,3 +1,3 @@ rawBody | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Function rawBody

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Decorator which injects the raw HTTP request body as a parameter value.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Value passed to the method will be a Buffer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/functions/request.html b/docs/functions/request.html index 40449ef4..fce4924e 100644 --- a/docs/functions/request.html +++ b/docs/functions/request.html @@ -1,3 +1,3 @@ request | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Function request

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/functions/response.html b/docs/functions/response.html index 7ab40e11..9a2de082 100644 --- a/docs/functions/response.html +++ b/docs/functions/response.html @@ -1,3 +1,3 @@ response | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Function response

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • classDefinition: object | Function
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • methodName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • paramIndex: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/rolesAllowed.html b/docs/functions/rolesAllowed.html index d0510ac1..f3e87f9c 100644 --- a/docs/functions/rolesAllowed.html +++ b/docs/functions/rolesAllowed.html @@ -3,4 +3,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Role based authorization is managed by an IAuthorizer implementation registered with the current app.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ...roleNames: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Names of roles that are permitted to use the endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns (classDefinition: object | Function, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns (classDefinition: object | Function, methodName: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/functions/timed.html b/docs/functions/timed.html index 13141a30..8916ab32 100644 --- a/docs/functions/timed.html +++ b/docs/functions/timed.html @@ -3,4 +3,4 @@ is output to the console.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        The environment variable PROFILE_API must be set to 1 for profiling information to be recorded and output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/hierarchy.html b/docs/hierarchy.html index a9fd4743..2adbaddf 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy Summary

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/index.html b/docs/index.html index 7a5432a8..4bec5240 100644 --- a/docs/index.html +++ b/docs/index.html @@ -22,6 +22,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-apiDeploy to AWS Lambda @@ -33,6 +34,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-apiDeploy to AWS Lambda
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Routing @@ -133,7 +135,7 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/IAuthFilter.html b/docs/interfaces/IAuthFilter.html index 0dfcef10..23c92b45 100644 --- a/docs/interfaces/IAuthFilter.html +++ b/docs/interfaces/IAuthFilter.html @@ -2,22 +2,22 @@ from a HTTP request and preform authentication using that data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface IAuthFilter<T, U extends Principal> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                authenticationSchemeName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                authenticate(authData: T): Promise<U>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                extractAuthData(request: Request): Promise<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Authentication data type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • U extends Principal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Principal data type, the type must extend Principal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            authenticationSchemeName +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            authenticationSchemeName name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            authenticate extractAuthData

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            authenticationSchemeName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            String to use in WWW-Authenticate header when returing a HTTP 401 response, see: https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A human readable name for this authentication filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A human readable name for this authentication filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

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

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • authData: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                An instance of the authentication data type T.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<U>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Instance of type U or undefined on authentication failure.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Extract an instance of the authentication data type T from a HTTP request. If extraction is not possible due to missing request headers/data, undefined should be returned.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • request: Request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Request context to use.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Instance of type T or undefined on extraction failure.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/IAuthorizer.html b/docs/interfaces/IAuthorizer.html index 8b279100..de9fdded 100644 --- a/docs/interfaces/IAuthorizer.html +++ b/docs/interfaces/IAuthorizer.html @@ -1,10 +1,10 @@ IAuthorizer | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface IAuthorizer<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Authorizer to perform role based checks for a principal.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Principal data type, the type must extend Principal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface IAuthorizer<T extends Principal> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  authorize(principal: T, role: string): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface IAuthorizer<T extends Principal> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  authorize(principal: T, role: string): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              authorize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A human readable name for this authorizer.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Check that a principal has a named role.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • principal: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The current principal context.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • role: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The name of the role to check for.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                true if the principal is authorised to use the name role, otherwise false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/IDictionary.html b/docs/interfaces/IDictionary.html index 51b3df4b..c36e0686 100644 --- a/docs/interfaces/IDictionary.html +++ b/docs/interfaces/IDictionary.html @@ -1 +1 @@ -IDictionary | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface IDictionary<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [key: string]: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +IDictionary | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface IDictionary<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [key: string]: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/ILogger.html b/docs/interfaces/ILogger.html index b701d10e..94c9d83e 100644 --- a/docs/interfaces/ILogger.html +++ b/docs/interfaces/ILogger.html @@ -1,5 +1,5 @@ ILogger | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface ILogger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Describes a generic logging implementation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface ILogger {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        format: LogFormat;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        level: LogLevel;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        debug(message: string, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        debugEnabled(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        error(message: string, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        errorEnabled(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        errorWithStack(message: string, ex: Error, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fatal(message: string, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fatalEnabled(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        info(message: string, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        infoEnabled(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isOff(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        levelEnabled(level: LogLevel): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        log(level: LogLevel, message: string, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        trace(message: string, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        traceEnabled(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        warn(message: string, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        warnEnabled(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    format +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface ILogger {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        format: LogFormat;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        level: LogLevel;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        debug(message: string, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        debugEnabled(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        error(message: string, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        errorEnabled(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        errorWithStack(message: string, ex: Error, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fatal(message: string, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fatalEnabled(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        info(message: string, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        infoEnabled(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isOff(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        levelEnabled(level: LogLevel): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        log(level: LogLevel, message: string, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        trace(message: string, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        traceEnabled(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        warn(message: string, ...formatArgs: any[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        warnEnabled(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    format level

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    debug debugEnabled @@ -18,40 +18,40 @@ warn warnEnabled

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    format: LogFormat

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See [[ServerLoggerConfig]]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    level: LogLevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See [[ServerLoggerConfig]]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    level: LogLevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See [[ServerLoggerConfig]]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Log a debug level message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • message: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String which can contain sprintf style format placeholders.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ...formatArgs: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        (Optional) Arguments which are passed to sprintf to format the message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Log a error level message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Log a error level message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • message: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String which can contain sprintf style format placeholders.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ...formatArgs: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        (Optional) Arguments which are passed to sprintf to format the message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Log a error level message with an associated error and stack trace.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Log a error level message with an associated error and stack trace.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • message: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String which can contain sprintf style format placeholders.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ex: Error

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Error object associated with this error message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ...formatArgs: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        (Optional) Arguments which are passed to sprintf to format the message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Log a fatal level message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Log a fatal level message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • message: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String which can contain sprintf style format placeholders.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ...formatArgs: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        (Optional) Arguments which are passed to sprintf to format the message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Log a info level message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Log a info level message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • message: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String which can contain sprintf style format placeholders.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ...formatArgs: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        (Optional) Arguments which are passed to sprintf to format the message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Is a given log level enabled?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Log a message with a custom level.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Log a message with a custom level.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • level: LogLevel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Level of the log message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • message: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String which can contain sprintf style format placeholders.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ...formatArgs: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        (Optional) Arguments which are passed to sprintf to format the message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Log a trace level message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Log a trace level message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • message: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String which can contain sprintf style format placeholders.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ...formatArgs: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        (Optional) Arguments which are passed to sprintf to format the message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Log a warn trace level message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Log a warn trace level message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • message: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        String which can contain sprintf style format placeholders.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ...formatArgs: any[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        (Optional) Arguments which are passed to sprintf to format the message.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.ALBEvent.html b/docs/interfaces/_internal_.ALBEvent.html index 20180135..b992cb08 100644 --- a/docs/interfaces/_internal_.ALBEvent.html +++ b/docs/interfaces/_internal_.ALBEvent.html @@ -1,4 +1,4 @@ -ALBEvent | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface ALBEvent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface ALBEvent {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          body: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          headers?: ALBEventHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          httpMethod: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isBase64Encoded: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          multiValueHeaders?: ALBEventMultiValueHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          multiValueQueryStringParameters?: ALBEventMultiValueQueryStringParameters;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          queryStringParameters?: ALBEventQueryStringParameters;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          requestContext: ALBEventRequestContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      body +ALBEvent | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ALBEvent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ALBEvent {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            body: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            headers?: ALBEventHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            httpMethod: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            isBase64Encoded: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            multiValueHeaders?: ALBEventMultiValueHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            multiValueQueryStringParameters?: ALBEventMultiValueQueryStringParameters;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            queryStringParameters?: ALBEventQueryStringParameters;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            requestContext: ALBEventRequestContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        body headers? httpMethod isBase64Encoded @@ -7,4 +7,4 @@ path queryStringParameters? requestContext -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        body

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        body: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        headers?: ALBEventHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        httpMethod: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isBase64Encoded: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        multiValueHeaders?: ALBEventMultiValueHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        multiValueQueryStringParameters?: ALBEventMultiValueQueryStringParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        queryStringParameters?: ALBEventQueryStringParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requestContext: ALBEventRequestContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        body

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        body: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        headers?: ALBEventHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        httpMethod: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isBase64Encoded: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        multiValueHeaders?: ALBEventMultiValueHeaders
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        multiValueQueryStringParameters?: ALBEventMultiValueQueryStringParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        queryStringParameters?: ALBEventQueryStringParameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requestContext: ALBEventRequestContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.ALBEventHeaders.html b/docs/interfaces/_internal_.ALBEventHeaders.html index 1e1964a3..f2cddb5b 100644 --- a/docs/interfaces/_internal_.ALBEventHeaders.html +++ b/docs/interfaces/_internal_.ALBEventHeaders.html @@ -1 +1 @@ -ALBEventHeaders | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ALBEventHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [name: string]: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +ALBEventHeaders | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ALBEventHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [name: string]: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.ALBEventMultiValueHeaders.html b/docs/interfaces/_internal_.ALBEventMultiValueHeaders.html index b8f2e26b..309740dc 100644 --- a/docs/interfaces/_internal_.ALBEventMultiValueHeaders.html +++ b/docs/interfaces/_internal_.ALBEventMultiValueHeaders.html @@ -1 +1 @@ -ALBEventMultiValueHeaders | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface ALBEventMultiValueHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [name: string]: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +ALBEventMultiValueHeaders | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface ALBEventMultiValueHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [name: string]: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.ALBEventMultiValueQueryStringParameters.html b/docs/interfaces/_internal_.ALBEventMultiValueQueryStringParameters.html index 428c9ac8..08ae8ce3 100644 --- a/docs/interfaces/_internal_.ALBEventMultiValueQueryStringParameters.html +++ b/docs/interfaces/_internal_.ALBEventMultiValueQueryStringParameters.html @@ -1 +1 @@ -ALBEventMultiValueQueryStringParameters | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface ALBEventMultiValueQueryStringParameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [name: string]: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +ALBEventMultiValueQueryStringParameters | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface ALBEventMultiValueQueryStringParameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [name: string]: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.ALBEventQueryStringParameters.html b/docs/interfaces/_internal_.ALBEventQueryStringParameters.html index 2d4aaa7c..b734ce6c 100644 --- a/docs/interfaces/_internal_.ALBEventQueryStringParameters.html +++ b/docs/interfaces/_internal_.ALBEventQueryStringParameters.html @@ -1 +1 @@ -ALBEventQueryStringParameters | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface ALBEventQueryStringParameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [name: string]: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +ALBEventQueryStringParameters | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ALBEventQueryStringParameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [name: string]: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.ALBEventRequestContext.html b/docs/interfaces/_internal_.ALBEventRequestContext.html index 7a4b2250..d2ba5acf 100644 --- a/docs/interfaces/_internal_.ALBEventRequestContext.html +++ b/docs/interfaces/_internal_.ALBEventRequestContext.html @@ -1,2 +1,2 @@ -ALBEventRequestContext | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ALBEventRequestContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ALBEventRequestContext {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              elb: { targetGroupArn: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          elb -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          elb: { targetGroupArn: string }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +ALBEventRequestContext | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ALBEventRequestContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ALBEventRequestContext {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                elb: { targetGroupArn: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            elb +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            elb: { targetGroupArn: string }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.AbortSignal-2.html b/docs/interfaces/_internal_.AbortSignal-2.html index eac5a5c7..5ce9f547 100644 --- a/docs/interfaces/_internal_.AbortSignal-2.html +++ b/docs/interfaces/_internal_.AbortSignal-2.html @@ -1,4 +1,4 @@ -AbortSignal | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface AbortSignal {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  aborted: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onabort: (this: AbortSignal, ev: Event) => any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  reason: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  addEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: boolean | AddEventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dispatchEvent(event: Event): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  removeEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: boolean | EventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throwIfAborted(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              aborted +AbortSignal | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface AbortSignal {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    aborted: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    onabort: (this: AbortSignal, ev: Event) => any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    reason: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: boolean | AddEventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    dispatchEvent(event: Event): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    removeEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: boolean | EventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throwIfAborted(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                aborted onabort reason

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                addEventListener diff --git a/docs/interfaces/_internal_.AbortSignal.html b/docs/interfaces/_internal_.AbortSignal.html index fe1a3756..7dba3702 100644 --- a/docs/interfaces/_internal_.AbortSignal.html +++ b/docs/interfaces/_internal_.AbortSignal.html @@ -1,4 +1,4 @@ -AbortSignal | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface AbortSignal {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      aborted: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      onabort: (this: AbortSignal, ev: Event) => any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      reason: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      addEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: boolean | AddEventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      dispatchEvent(event: Event): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      removeEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: boolean | EventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      throwIfAborted(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  aborted +AbortSignal | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface AbortSignal {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        aborted: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        onabort: (this: AbortSignal, ev: Event) => any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        reason: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        addEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: boolean | AddEventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        dispatchEvent(event: Event): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        removeEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: boolean | EventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        throwIfAborted(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    aborted onabort reason

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addEventListener diff --git a/docs/interfaces/_internal_.AddEventListenerOptions.html b/docs/interfaces/_internal_.AddEventListenerOptions.html index 9c9d3f8a..0d065cf5 100644 --- a/docs/interfaces/_internal_.AddEventListenerOptions.html +++ b/docs/interfaces/_internal_.AddEventListenerOptions.html @@ -1,4 +1,4 @@ -AddEventListenerOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface AddEventListenerOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface AddEventListenerOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          capture?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          once?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          passive?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      capture? +AddEventListenerOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface AddEventListenerOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface AddEventListenerOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            capture?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            once?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            passive?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        capture? once? passive? signal? diff --git a/docs/interfaces/_internal_.AddOperation.html b/docs/interfaces/_internal_.AddOperation.html index 50b70dc2..20cfc907 100644 --- a/docs/interfaces/_internal_.AddOperation.html +++ b/docs/interfaces/_internal_.AddOperation.html @@ -1,4 +1,4 @@ -AddOperation | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface AddOperation<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface AddOperation<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              op: "add";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              value: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          op +AddOperation | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface AddOperation<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface AddOperation<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                op: "add";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                value: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            op path value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            op: "add"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            path: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            value: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.AgentOptions-1.html b/docs/interfaces/_internal_.AgentOptions-1.html index fe20454d..6755ce44 100644 --- a/docs/interfaces/_internal_.AgentOptions-1.html +++ b/docs/interfaces/_internal_.AgentOptions-1.html @@ -1,4 +1,4 @@ -AgentOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface AgentOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface AgentOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  agentKeepAliveTimeoutBuffer?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  allowPartialTrustChain?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  autoSelectFamily?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  autoSelectFamilyAttemptTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  blockList?: BlockList;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ca?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cert?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  checkServerIdentity?: (hostname: string, cert: PeerCertificate) => Error;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ciphers?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  clientCertEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  crl?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  defaultPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dhparam?: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ecdhCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  enableTrace?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  honorCipherOrder?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keepAlive?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keepAliveInitialDelay?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keepAliveMsecs?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike> | KeyObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxCachedSessions?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxFreeSockets?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxSockets?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxTotalSockets?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minDHSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  noDelay?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  passphrase?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike> | PxfObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  port?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  privateKeyEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  privateKeyIdentifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  proxyEnv?: ProxyEnv;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pskCallback?: (hint: string) => PSKCallbackNegotation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  rejectUnauthorized?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  requestCert?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  scheduling?: "fifo" | "lifo";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secureContext?: SecureContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secureOptions?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secureProtocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  servername?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  session?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sessionIdContext?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sessionTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sigalgs?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SNICallback?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      servername: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  socket?: Duplex;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ticketKeys?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              agentKeepAliveTimeoutBuffer? +AgentOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface AgentOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface AgentOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    agentKeepAliveTimeoutBuffer?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    allowPartialTrustChain?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    autoSelectFamily?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    autoSelectFamilyAttemptTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    blockList?: BlockList;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ca?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cert?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    checkServerIdentity?: (hostname: string, cert: PeerCertificate) => Error;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ciphers?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    clientCertEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    crl?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    defaultPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    dhparam?: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ecdhCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    enableTrace?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    honorCipherOrder?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    keepAlive?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    keepAliveInitialDelay?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    keepAliveMsecs?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | (string | Buffer<ArrayBufferLike> | KeyObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    maxCachedSessions?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    maxFreeSockets?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    maxSockets?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    maxTotalSockets?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    maxVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    minDHSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    minVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    noDelay?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    passphrase?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | (string | Buffer<ArrayBufferLike> | PxfObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    port?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    privateKeyEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    privateKeyIdentifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    proxyEnv?: ProxyEnv;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pskCallback?: (hint: string) => PSKCallbackNegotation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rejectUnauthorized?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    requestCert?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scheduling?: "fifo" | "lifo";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    secureContext?: SecureContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    secureOptions?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    secureProtocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    servername?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    session?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    sessionIdContext?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    sessionTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    sigalgs?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SNICallback?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        servername: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    socket?: Duplex;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ticketKeys?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                agentKeepAliveTimeoutBuffer? allowPartialTrustChain? ALPNCallback? ALPNProtocols? diff --git a/docs/interfaces/_internal_.AgentOptions.html b/docs/interfaces/_internal_.AgentOptions.html index 6e1723ff..5dd8a905 100644 --- a/docs/interfaces/_internal_.AgentOptions.html +++ b/docs/interfaces/_internal_.AgentOptions.html @@ -1,4 +1,4 @@ -AgentOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface AgentOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface AgentOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      agentKeepAliveTimeoutBuffer?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      autoSelectFamily?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      autoSelectFamilyAttemptTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      blockList?: BlockList;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      defaultPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      keepAlive?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      keepAliveInitialDelay?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      keepAliveMsecs?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      maxFreeSockets?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      maxSockets?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      maxTotalSockets?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      noDelay?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      port?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      proxyEnv?: ProxyEnv;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scheduling?: "fifo" | "lifo";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  agentKeepAliveTimeoutBuffer? +AgentOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface AgentOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface AgentOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentKeepAliveTimeoutBuffer?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        autoSelectFamily?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        autoSelectFamilyAttemptTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        blockList?: BlockList;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        keepAlive?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        keepAliveInitialDelay?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        keepAliveMsecs?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxFreeSockets?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxSockets?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxTotalSockets?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        noDelay?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        port?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        proxyEnv?: ProxyEnv;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        scheduling?: "fifo" | "lifo";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    agentKeepAliveTimeoutBuffer? autoSelectFamily? autoSelectFamilyAttemptTimeout? blockList? diff --git a/docs/interfaces/_internal_.ArrayIterator.html b/docs/interfaces/_internal_.ArrayIterator.html index e85fc856..ba5c0528 100644 --- a/docs/interfaces/_internal_.ArrayIterator.html +++ b/docs/interfaces/_internal_.ArrayIterator.html @@ -1,4 +1,4 @@ -ArrayIterator | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface ArrayIterator<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface ArrayIterator<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[dispose]"(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[iterator]"(): ArrayIterator<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          next(...__namedParameters: [] | [unknown]): IteratorResult<T, any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          return?(value?: any): IteratorResult<T, any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throw?(e?: any): IteratorResult<T, any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [dispose] +ArrayIterator | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ArrayIterator<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ArrayIterator<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[dispose]"(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[iterator]"(): ArrayIterator<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            next(...__namedParameters: [] | [unknown]): IteratorResult<T, any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            return?(value?: any): IteratorResult<T, any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throw?(e?: any): IteratorResult<T, any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [dispose] [iterator] next return? diff --git a/docs/interfaces/_internal_.AsyncGenerator.html b/docs/interfaces/_internal_.AsyncGenerator.html index 744124e4..c6a9b3cb 100644 --- a/docs/interfaces/_internal_.AsyncGenerator.html +++ b/docs/interfaces/_internal_.AsyncGenerator.html @@ -1,4 +1,4 @@ -AsyncGenerator | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface AsyncGenerator<T, TReturn, TNext>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface AsyncGenerator<T = unknown, TReturn = any, TNext = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "[asyncDispose]"(): PromiseLike<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "[asyncIterator]"(): AsyncGenerator<T, TReturn, TNext>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              next(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ...__namedParameters: [] | [TNext],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              return(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: TReturn | PromiseLike<TReturn>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              throw(e: any): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T = unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • TReturn = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • TNext = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [asyncDispose] +AsyncGenerator | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface AsyncGenerator<T, TReturn, TNext>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface AsyncGenerator<T = unknown, TReturn = any, TNext = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "[asyncDispose]"(): PromiseLike<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "[asyncIterator]"(): AsyncGenerator<T, TReturn, TNext>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                next(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ...__namedParameters: [] | [TNext],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                return(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    value: TReturn | PromiseLike<TReturn>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throw(e: any): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T = unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • TReturn = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • TNext = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [asyncDispose] [asyncIterator] next return diff --git a/docs/interfaces/_internal_.AsyncIterableIterator.html b/docs/interfaces/_internal_.AsyncIterableIterator.html index d1b30daf..b1626896 100644 --- a/docs/interfaces/_internal_.AsyncIterableIterator.html +++ b/docs/interfaces/_internal_.AsyncIterableIterator.html @@ -1,5 +1,5 @@ AsyncIterableIterator | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface AsyncIterableIterator<T, TReturn, TNext>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Describes a user-defined AsyncIterator that is also async iterable.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface AsyncIterableIterator<T, TReturn = any, TNext = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "[asyncIterator]"(): AsyncIterableIterator<T, TReturn, TNext>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  next(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ...__namedParameters: [] | [TNext],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  return?(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      value?: TReturn | PromiseLike<TReturn>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throw?(e?: any): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • TReturn = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • TNext = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [asyncIterator] +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface AsyncIterableIterator<T, TReturn = any, TNext = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "[asyncIterator]"(): AsyncIterableIterator<T, TReturn, TNext>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  next(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ...__namedParameters: [] | [TNext],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  return?(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      value?: TReturn | PromiseLike<TReturn>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throw?(e?: any): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • TReturn = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • TNext = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [asyncIterator] next return? throw? diff --git a/docs/interfaces/_internal_.AsyncIterator.html b/docs/interfaces/_internal_.AsyncIterator.html index 7295e2af..032608c8 100644 --- a/docs/interfaces/_internal_.AsyncIterator.html +++ b/docs/interfaces/_internal_.AsyncIterator.html @@ -1,4 +1,4 @@ -AsyncIterator | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface AsyncIterator<T, TReturn, TNext>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface AsyncIterator<T, TReturn = any, TNext = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    next(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ...__namedParameters: [] | [TNext],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    return?(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        value?: TReturn | PromiseLike<TReturn>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throw?(e?: any): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TReturn = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • TNext = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                next +AsyncIterator | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface AsyncIterator<T, TReturn, TNext>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface AsyncIterator<T, TReturn = any, TNext = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      next(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ...__namedParameters: [] | [TNext],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      return?(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          value?: TReturn | PromiseLike<TReturn>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      throw?(e?: any): Promise<IteratorResult<T, TReturn>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TReturn = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • TNext = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  next return? throw?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.AsyncResourceOptions.html b/docs/interfaces/_internal_.AsyncResourceOptions.html index 88b6ccc6..df3bab0e 100644 --- a/docs/interfaces/_internal_.AsyncResourceOptions.html +++ b/docs/interfaces/_internal_.AsyncResourceOptions.html @@ -1,4 +1,4 @@ -AsyncResourceOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface AsyncResourceOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface AsyncResourceOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requireManualDestroy?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        triggerAsyncId?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    requireManualDestroy? +AsyncResourceOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface AsyncResourceOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface AsyncResourceOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          requireManualDestroy?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          triggerAsyncId?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      requireManualDestroy? triggerAsyncId?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      requireManualDestroy?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Disables automatic emitDestroy when the object is garbage collected. This usually does not need to be set (even if emitDestroy is called diff --git a/docs/interfaces/_internal_.AwsCredentialIdentity.html b/docs/interfaces/_internal_.AwsCredentialIdentity.html index 505637fc..f4581fb8 100644 --- a/docs/interfaces/_internal_.AwsCredentialIdentity.html +++ b/docs/interfaces/_internal_.AwsCredentialIdentity.html @@ -1,4 +1,4 @@ -AwsCredentialIdentity | ts-lambda-api - v2.5.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface AwsCredentialIdentity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface AwsCredentialIdentity {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            accessKeyId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            accountId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            credentialScope?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            expiration?: Date;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            secretAccessKey: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sessionToken?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accessKeyId +AwsCredentialIdentity | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface AwsCredentialIdentity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface AwsCredentialIdentity {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              accessKeyId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              accountId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              credentialScope?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              expiration?: Date;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              secretAccessKey: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sessionToken?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          accessKeyId accountId? credentialScope? expiration? diff --git a/docs/interfaces/_internal_.AwsRegionExtensionConfiguration.html b/docs/interfaces/_internal_.AwsRegionExtensionConfiguration.html index 75ea1008..5be64e02 100644 --- a/docs/interfaces/_internal_.AwsRegionExtensionConfiguration.html +++ b/docs/interfaces/_internal_.AwsRegionExtensionConfiguration.html @@ -1,3 +1,3 @@ -AwsRegionExtensionConfiguration | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface AwsRegionExtensionConfigurationInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface AwsRegionExtensionConfiguration {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                region(): Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                setRegion(region: Provider<string>): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            region +AwsRegionExtensionConfiguration | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface AwsRegionExtensionConfigurationInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface AwsRegionExtensionConfiguration {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  region(): Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  setRegion(region: Provider<string>): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              region setRegion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Returns Provider<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.AwsSdkSigV4AAuthInputConfig.html b/docs/interfaces/_internal_.AwsSdkSigV4AAuthInputConfig.html index 0330c902..7e630aeb 100644 --- a/docs/interfaces/_internal_.AwsSdkSigV4AAuthInputConfig.html +++ b/docs/interfaces/_internal_.AwsSdkSigV4AAuthInputConfig.html @@ -1,4 +1,4 @@ -AwsSdkSigV4AAuthInputConfig | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface AwsSdkSigV4AAuthInputConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface AwsSdkSigV4AAuthInputConfig {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    sigv4aSigningRegionSet?: string[] | Provider<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sigv4aSigningRegionSet? +AwsSdkSigV4AAuthInputConfig | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface AwsSdkSigV4AAuthInputConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface AwsSdkSigV4AAuthInputConfig {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sigv4aSigningRegionSet?: string[] | Provider<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sigv4aSigningRegionSet?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sigv4aSigningRegionSet?: string[] | Provider<string[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This option will override the AWS sigv4a signing regionSet from any other source.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The lookup order is:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.AwsSdkSigV4AuthInputConfig.html b/docs/interfaces/_internal_.AwsSdkSigV4AuthInputConfig.html index 0fabccc0..23267d36 100644 --- a/docs/interfaces/_internal_.AwsSdkSigV4AuthInputConfig.html +++ b/docs/interfaces/_internal_.AwsSdkSigV4AuthInputConfig.html @@ -1,4 +1,4 @@ -AwsSdkSigV4AuthInputConfig | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface AwsSdkSigV4AuthInputConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface AwsSdkSigV4AuthInputConfig {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signer?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | RequestSigner
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | ((authScheme?: AuthScheme) => Promise<RequestSigner>);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signerConstructor?: new (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => RequestSigner;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingEscapePath?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingRegion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        systemClockOffset?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    credentials? +AwsSdkSigV4AuthInputConfig | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface AwsSdkSigV4AuthInputConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface AwsSdkSigV4AuthInputConfig {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signer?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | RequestSigner
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | ((authScheme?: AuthScheme) => Promise<RequestSigner>);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signerConstructor?: new (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ) => RequestSigner;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingEscapePath?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingRegion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          systemClockOffset?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      credentials? signer? signerConstructor? signingEscapePath? diff --git a/docs/interfaces/_internal_.BaseMultipleResolvedValueMetadataInjectOptions.html b/docs/interfaces/_internal_.BaseMultipleResolvedValueMetadataInjectOptions.html index 97e2d503..9f5f951e 100644 --- a/docs/interfaces/_internal_.BaseMultipleResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.BaseMultipleResolvedValueMetadataInjectOptions.html @@ -1,3 +1,3 @@ -BaseMultipleResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface BaseMultipleResolvedValueMetadataInjectOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface BaseMultipleResolvedValueMetadataInjectOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            chained?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            isMultiple: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        chained? +BaseMultipleResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface BaseMultipleResolvedValueMetadataInjectOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface BaseMultipleResolvedValueMetadataInjectOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              chained?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              isMultiple: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          chained? isMultiple

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          chained?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isMultiple: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.BaseOperation.html b/docs/interfaces/_internal_.BaseOperation.html index 3b75539a..be953d92 100644 --- a/docs/interfaces/_internal_.BaseOperation.html +++ b/docs/interfaces/_internal_.BaseOperation.html @@ -1,2 +1,2 @@ -BaseOperation | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface BaseOperation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface BaseOperation {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            path +BaseOperation | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface BaseOperation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface BaseOperation {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              path

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              path: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.BaseOptionalResolvedValueMetadataInjectOptions.html b/docs/interfaces/_internal_.BaseOptionalResolvedValueMetadataInjectOptions.html index 08702e81..3e2ae61c 100644 --- a/docs/interfaces/_internal_.BaseOptionalResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.BaseOptionalResolvedValueMetadataInjectOptions.html @@ -1,2 +1,2 @@ -BaseOptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface BaseOptionalResolvedValueMetadataInjectOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface BaseOptionalResolvedValueMetadataInjectOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    optional: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                optional +BaseOptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface BaseOptionalResolvedValueMetadataInjectOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface BaseOptionalResolvedValueMetadataInjectOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      optional: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  optional

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  optional: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.BaseParameterObject.html b/docs/interfaces/_internal_.BaseParameterObject.html index 71ac4549..c30eecb4 100644 --- a/docs/interfaces/_internal_.BaseParameterObject.html +++ b/docs/interfaces/_internal_.BaseParameterObject.html @@ -1,4 +1,4 @@ -BaseParameterObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface BaseParameterObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface BaseParameterObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowEmptyValue?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowReserved?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        content?: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        example?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        examples?: { [param: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        explode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        required?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        style?: ParameterStyle;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    allowEmptyValue? +BaseParameterObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface BaseParameterObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface BaseParameterObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allowEmptyValue?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allowReserved?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          content?: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          example?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          examples?: { [param: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          explode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          required?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          style?: ParameterStyle;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      allowEmptyValue? allowReserved? content? deprecated? diff --git a/docs/interfaces/_internal_.BaseResolvedValueMetadataInjectOptions.html b/docs/interfaces/_internal_.BaseResolvedValueMetadataInjectOptions.html index 54a495e0..b3021319 100644 --- a/docs/interfaces/_internal_.BaseResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.BaseResolvedValueMetadataInjectOptions.html @@ -1,4 +1,4 @@ -BaseResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface BaseResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface BaseResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name? +BaseResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface BaseResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface BaseResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name? serviceIdentifier tags?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name?: MetadataName
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tags?: ResolvedValueMetadataInjectTagOptions[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.BindInFluentSyntax.html b/docs/interfaces/_internal_.BindInFluentSyntax.html index dc3cfc55..8bac3e92 100644 --- a/docs/interfaces/_internal_.BindInFluentSyntax.html +++ b/docs/interfaces/_internal_.BindInFluentSyntax.html @@ -1,4 +1,4 @@ -BindInFluentSyntax | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface BindInFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface BindInFluentSyntax<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getIdentifier(): BindingIdentifier;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                inRequestScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                inSingletonScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                inTransientScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getIdentifier +BindInFluentSyntax | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface BindInFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface BindInFluentSyntax<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getIdentifier(): BindingIdentifier;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  inRequestScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  inSingletonScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  inTransientScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getIdentifier inRequestScope inSingletonScope inTransientScope diff --git a/docs/interfaces/_internal_.BindInWhenOnFluentSyntax.html b/docs/interfaces/_internal_.BindInWhenOnFluentSyntax.html index 2b7bbf79..a90ccc09 100644 --- a/docs/interfaces/_internal_.BindInWhenOnFluentSyntax.html +++ b/docs/interfaces/_internal_.BindInWhenOnFluentSyntax.html @@ -1,4 +1,4 @@ -BindInWhenOnFluentSyntax | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface BindInWhenOnFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface BindInWhenOnFluentSyntax<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getIdentifier(): BindingIdentifier;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    inRequestScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    inSingletonScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    inTransientScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    onActivation(activation: BindingActivation<T>): BindWhenFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    onDeactivation(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deactivation: BindingDeactivation<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): BindWhenFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    when(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenAnyAncestor(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenAnyAncestorIs(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenAnyAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenAnyAncestorTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenDefault(): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoAncestor(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoAncestorIs(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoAncestorTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoParent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenNoParentTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenParent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenParentTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    whenTagged(tag: MetadataTag, tagValue: unknown): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getIdentifier +BindInWhenOnFluentSyntax | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface BindInWhenOnFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface BindInWhenOnFluentSyntax<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getIdentifier(): BindingIdentifier;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      inRequestScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      inSingletonScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      inTransientScope(): BindWhenOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      onActivation(activation: BindingActivation<T>): BindWhenFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      onDeactivation(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deactivation: BindingDeactivation<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): BindWhenFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      when(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenAnyAncestor(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenAnyAncestorIs(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenAnyAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenAnyAncestorTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenDefault(): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenNoAncestor(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenNoAncestorIs(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenNoAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenNoAncestorTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenNoParent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenNoParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenNoParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenNoParentTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenParent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenParentTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      whenTagged(tag: MetadataTag, tagValue: unknown): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getIdentifier inRequestScope inSingletonScope inTransientScope diff --git a/docs/interfaces/_internal_.BindOnFluentSyntax.html b/docs/interfaces/_internal_.BindOnFluentSyntax.html index 34e59cca..1eab96e3 100644 --- a/docs/interfaces/_internal_.BindOnFluentSyntax.html +++ b/docs/interfaces/_internal_.BindOnFluentSyntax.html @@ -1,4 +1,4 @@ -BindOnFluentSyntax | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface BindOnFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface BindOnFluentSyntax<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getIdentifier(): BindingIdentifier;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        onActivation(activation: BindingActivation<T>): BindWhenFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        onDeactivation(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deactivation: BindingDeactivation<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): BindWhenFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getIdentifier +BindOnFluentSyntax | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface BindOnFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface BindOnFluentSyntax<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getIdentifier(): BindingIdentifier;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          onActivation(activation: BindingActivation<T>): BindWhenFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          onDeactivation(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              deactivation: BindingDeactivation<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): BindWhenFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getIdentifier onActivation onDeactivation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.BindWhenFluentSyntax.html b/docs/interfaces/_internal_.BindWhenFluentSyntax.html index 06c47992..ebb57241 100644 --- a/docs/interfaces/_internal_.BindWhenFluentSyntax.html +++ b/docs/interfaces/_internal_.BindWhenFluentSyntax.html @@ -1,4 +1,4 @@ -BindWhenFluentSyntax | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface BindWhenFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface BindWhenFluentSyntax<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getIdentifier(): BindingIdentifier;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            when(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenAnyAncestor(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenAnyAncestorIs(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenAnyAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenAnyAncestorTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenDefault(): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenNoAncestor(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenNoAncestorIs(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenNoAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenNoAncestorTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenNoParent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenNoParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenNoParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenNoParentTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenParent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenParentTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            whenTagged(tag: MetadataTag, tagValue: unknown): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getIdentifier +BindWhenFluentSyntax | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface BindWhenFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface BindWhenFluentSyntax<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getIdentifier(): BindingIdentifier;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              when(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenAnyAncestor(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenAnyAncestorIs(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenAnyAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenAnyAncestorTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenDefault(): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenNoAncestor(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenNoAncestorIs(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenNoAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenNoAncestorTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenNoParent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenNoParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenNoParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenNoParentTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenParent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenParentTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              whenTagged(tag: MetadataTag, tagValue: unknown): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getIdentifier when whenAnyAncestor whenAnyAncestorIs diff --git a/docs/interfaces/_internal_.BindWhenOnFluentSyntax.html b/docs/interfaces/_internal_.BindWhenOnFluentSyntax.html index a369c9ee..dfbe8c08 100644 --- a/docs/interfaces/_internal_.BindWhenOnFluentSyntax.html +++ b/docs/interfaces/_internal_.BindWhenOnFluentSyntax.html @@ -1,4 +1,4 @@ -BindWhenOnFluentSyntax | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface BindWhenOnFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface BindWhenOnFluentSyntax<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getIdentifier(): BindingIdentifier;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                onActivation(activation: BindingActivation<T>): BindWhenFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                onDeactivation(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deactivation: BindingDeactivation<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindWhenFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                when(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenAnyAncestor(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenAnyAncestorIs(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenAnyAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenAnyAncestorTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenDefault(): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenNoAncestor(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenNoAncestorIs(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenNoAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenNoAncestorTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenNoParent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenNoParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenNoParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenNoParentTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenParent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenParentTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                whenTagged(tag: MetadataTag, tagValue: unknown): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getIdentifier +BindWhenOnFluentSyntax | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface BindWhenOnFluentSyntax<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface BindWhenOnFluentSyntax<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getIdentifier(): BindingIdentifier;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onActivation(activation: BindingActivation<T>): BindWhenFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onDeactivation(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deactivation: BindingDeactivation<T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindWhenFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  when(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenAnyAncestor(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenAnyAncestorIs(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenAnyAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenAnyAncestorTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenDefault(): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenNoAncestor(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenNoAncestorIs(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      serviceIdentifier: ServiceIdentifier,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenNoAncestorNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenNoAncestorTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenNoParent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenNoParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenNoParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenNoParentTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenParent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      constraint: (metadata: BindingConstraints) => boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenParentIs(serviceIdentifier: ServiceIdentifier): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenParentNamed(name: MetadataName): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenParentTagged(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tag: MetadataTag,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tagValue: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  whenTagged(tag: MetadataTag, tagValue: unknown): BindOnFluentSyntax<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getIdentifier onActivation onDeactivation when diff --git a/docs/interfaces/_internal_.BoundServiceSyntax.html b/docs/interfaces/_internal_.BoundServiceSyntax.html index 60549de8..dba54008 100644 --- a/docs/interfaces/_internal_.BoundServiceSyntax.html +++ b/docs/interfaces/_internal_.BoundServiceSyntax.html @@ -1,2 +1,2 @@ -BoundServiceSyntax | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface BoundServiceSyntax

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface BoundServiceSyntax {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getIdentifier(): BindingIdentifier;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getIdentifier +BoundServiceSyntax | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface BoundServiceSyntax

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface BoundServiceSyntax {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getIdentifier(): BindingIdentifier;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getIdentifier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.CallbackObject.html b/docs/interfaces/_internal_.CallbackObject.html index ef3d1179..1760781b 100644 --- a/docs/interfaces/_internal_.CallbackObject.html +++ b/docs/interfaces/_internal_.CallbackObject.html @@ -1 +1 @@ -CallbackObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface CallbackObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [name: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [extensionName: `x-${string}`]: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +CallbackObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface CallbackObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [name: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [extensionName: `x-${string}`]: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/_internal_.CallbacksObject.html b/docs/interfaces/_internal_.CallbacksObject.html index 9fb94c71..67a84456 100644 --- a/docs/interfaces/_internal_.CallbacksObject.html +++ b/docs/interfaces/_internal_.CallbacksObject.html @@ -1 +1 @@ -CallbacksObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface CallbacksObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [name: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [extensionName: `x-${string}`]: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +CallbacksObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface CallbacksObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [name: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [extensionName: `x-${string}`]: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.Certificate.html b/docs/interfaces/_internal_.Certificate.html index 40d2a3f0..a0ed25b0 100644 --- a/docs/interfaces/_internal_.Certificate.html +++ b/docs/interfaces/_internal_.Certificate.html @@ -1,4 +1,4 @@ -Certificate | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface Certificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface Certificate {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                C?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                CN?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                L?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                O?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OU?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ST?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [key: string]: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Dict<string | string[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Certificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [key: string]: string | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            C? +Certificate | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface Certificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface Certificate {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  C?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  CN?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  L?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  O?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OU?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ST?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [key: string]: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Dict<string | string[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Certificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [key: string]: string | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              C? CN? L? O? diff --git a/docs/interfaces/_internal_.ChecksumConfiguration.html b/docs/interfaces/_internal_.ChecksumConfiguration.html index a1b7e09b..bc2a37b6 100644 --- a/docs/interfaces/_internal_.ChecksumConfiguration.html +++ b/docs/interfaces/_internal_.ChecksumConfiguration.html @@ -1,3 +1,3 @@ -ChecksumConfiguration | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface ChecksumConfigurationInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface ChecksumConfiguration {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addChecksumAlgorithm(algo: ChecksumAlgorithm): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    checksumAlgorithms(): ChecksumAlgorithm[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [key: number]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [key: number]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                addChecksumAlgorithm +ChecksumConfiguration | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface ChecksumConfigurationInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface ChecksumConfiguration {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      addChecksumAlgorithm(algo: ChecksumAlgorithm): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      checksumAlgorithms(): ChecksumAlgorithm[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [key: number]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [key: number]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  addChecksumAlgorithm checksumAlgorithms

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.ClientDefaults.html b/docs/interfaces/_internal_.ClientDefaults.html index 5fd28063..39c50308 100644 --- a/docs/interfaces/_internal_.ClientDefaults.html +++ b/docs/interfaces/_internal_.ClientDefaults.html @@ -1,4 +1,4 @@ -ClientDefaults | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface ClientDefaults

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface ClientDefaults {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiVersion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        base64Decoder?: Decoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        base64Encoder?: Encoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bodyLengthChecker?: BodyLengthCalculator;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cacheMiddleware?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultUserAgentProvider?: Provider<UserAgent>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        disableHostPrefix?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventStreamSerdeProvider?: EventStreamSerdeProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        extensions?: RuntimeExtension[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getAwsChunkedEncodingStream?: GetAwsChunkedEncodingStream;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        logger?: Logger;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxAttempts?: number | Provider<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        md5?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        profile?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        protocol?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | $ClientProtocol<any, any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | ClientProtocol<any, any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | ClientProtocolCtor<any, any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | $ClientProtocolCtor<any, any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        protocolSettings?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            defaultNamespace?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [setting: string]: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        region?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requestHandler?: HttpHandlerUserInput;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        retryMode?: string | Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        runtime?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sdkStreamMixin?: SdkStreamMixinInjector;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serviceId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sha1?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sha256?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingEscapePath?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        streamCollector?: StreamCollector;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        streamHasher?: StreamHasher<Readable> | StreamHasher<Blob>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        urlParser?: UrlParser;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useArnRegion?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useDualstackEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useFipsEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        utf8Decoder?: Decoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        utf8Encoder?: Encoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    apiVersion? +ClientDefaults | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface ClientDefaults

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface ClientDefaults {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          apiVersion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          base64Decoder?: Decoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          base64Encoder?: Encoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          bodyLengthChecker?: BodyLengthCalculator;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cacheMiddleware?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          defaultUserAgentProvider?: Provider<UserAgent>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          disableHostPrefix?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventStreamSerdeProvider?: EventStreamSerdeProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          extensions?: RuntimeExtension[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getAwsChunkedEncodingStream?: GetAwsChunkedEncodingStream;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          logger?: Logger;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          maxAttempts?: number | Provider<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          md5?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          profile?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          protocol?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | $ClientProtocol<any, any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | ClientProtocol<any, any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | ClientProtocolCtor<any, any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | $ClientProtocolCtor<any, any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          protocolSettings?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              defaultNamespace?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [setting: string]: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          region?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          requestHandler?: HttpHandlerUserInput;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          retryMode?: string | Provider<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          runtime?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sdkStreamMixin?: SdkStreamMixinInjector;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          serviceId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sha1?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sha256?: HashConstructor | ChecksumConstructor;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingEscapePath?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          streamCollector?: StreamCollector;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          streamHasher?: StreamHasher<Readable> | StreamHasher<Blob>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          urlParser?: UrlParser;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          useArnRegion?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          useDualstackEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          useFipsEndpoint?: boolean | Provider<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          utf8Decoder?: Decoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          utf8Encoder?: Encoder;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      apiVersion? base64Decoder? base64Encoder? bodyLengthChecker? diff --git a/docs/interfaces/_internal_.ClientProtocol.html b/docs/interfaces/_internal_.ClientProtocol.html index 0c6811cc..102bede6 100644 --- a/docs/interfaces/_internal_.ClientProtocol.html +++ b/docs/interfaces/_internal_.ClientProtocol.html @@ -1,6 +1,6 @@ ClientProtocol | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ClientProtocol<Request, Response>Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        A client protocol defines how to convert a message (e.g. HTTP request/response) to and from a data object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        use $ClientProtocol

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ClientProtocol<Request, Response> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deserializeResponse<Output extends MetadataBearer>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                operationSchema: OperationSchema,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                context: HandlerExecutionContext & SerdeFunctions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                response: Response,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<Output>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getPayloadCodec(): Codec<any, any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getRequestType(): new (...args: any[]) => Request;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getResponseType(): new (...args: any[]) => Response;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getShapeId(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            serializeRequest<Input extends object>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                operationSchema: OperationSchema,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                input: Input,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                context: HandlerExecutionContext & SerdeFunctions & EndpointBearer,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<Request>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setSerdeContext(serdeContext: SerdeFunctions): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            updateServiceEndpoint(request: Request, endpoint: EndpointV2): Request;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Request
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Response

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deserializeResponse +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ClientProtocol<Request, Response> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deserializeResponse<Output extends MetadataBearer>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                operationSchema: OperationSchema,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                context: HandlerExecutionContext & SerdeFunctions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                response: Response,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<Output>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getPayloadCodec(): Codec<any, any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getRequestType(): new (...args: any[]) => Request;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getResponseType(): new (...args: any[]) => Response;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getShapeId(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            serializeRequest<Input extends object>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                operationSchema: OperationSchema,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                input: Input,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                context: HandlerExecutionContext & SerdeFunctions & EndpointBearer,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<Request>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setSerdeContext(serdeContext: SerdeFunctions): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            updateServiceEndpoint(request: Request, endpoint: EndpointV2): Request;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Request
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Response

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deserializeResponse getPayloadCodec getRequestType getResponseType diff --git a/docs/interfaces/_internal_.ClientRequestArgs.html b/docs/interfaces/_internal_.ClientRequestArgs.html index de093b9b..cf35df32 100644 --- a/docs/interfaces/_internal_.ClientRequestArgs.html +++ b/docs/interfaces/_internal_.ClientRequestArgs.html @@ -1,5 +1,5 @@ ClientRequestArgs | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ClientRequestArgs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          From T, pick a set of properties whose keys are in the union K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ClientRequestArgs {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              _defaultAgent?: Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              agent?: boolean | Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              auth?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createConnection?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options: ClientRequestArgs,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  oncreate: (err: Error, socket: Duplex) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => Duplex;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              defaultPort?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              headers?: readonly string[] | OutgoingHttpHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hostname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              insecureHTTPParser?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              joinDuplicateHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              maxHeaderSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              method?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              port?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setDefaultHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setHost?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              socketPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              uniqueHeaders?: (string | string[])[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          _defaultAgent? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ClientRequestArgs {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              _defaultAgent?: Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              agent?: boolean | Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              auth?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createConnection?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options: ClientRequestArgs,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  oncreate: (err: Error, socket: Duplex) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => Duplex;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              defaultPort?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              headers?: readonly string[] | OutgoingHttpHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hostname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              insecureHTTPParser?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              joinDuplicateHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              maxHeaderSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              method?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              port?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setDefaultHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setHost?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              socketPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              uniqueHeaders?: (string | string[])[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          _defaultAgent? agent? auth? createConnection? diff --git a/docs/interfaces/_internal_.Codec.html b/docs/interfaces/_internal_.Codec.html index ff445a24..7b6d63be 100644 --- a/docs/interfaces/_internal_.Codec.html +++ b/docs/interfaces/_internal_.Codec.html @@ -1,6 +1,6 @@ Codec | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface Codec<S, D>Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            A codec creates serializers and deserializers for some format such as JSON, XML, or CBOR.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            use $Codec

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface Codec<S, D> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createDeserializer(): ShapeDeserializer<D>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createSerializer(): ShapeSerializer<S>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                setSerdeContext(serdeContext: SerdeFunctions): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • S
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • D

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createDeserializer +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface Codec<S, D> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createDeserializer(): ShapeDeserializer<D>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createSerializer(): ShapeSerializer<S>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                setSerdeContext(serdeContext: SerdeFunctions): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • S
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • D

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createDeserializer createSerializer setSerdeContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.CollectionTag.html b/docs/interfaces/_internal_.CollectionTag.html index f9b2eafe..d1e7580c 100644 --- a/docs/interfaces/_internal_.CollectionTag.html +++ b/docs/interfaces/_internal_.CollectionTag.html @@ -1,4 +1,4 @@ -CollectionTag | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface CollectionTag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface CollectionTag {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  collection: "map" | "seq";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  createNode?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      schema: Schema,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      value: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ctx: CreateNodeContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => Node;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  default?: boolean | "key";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  format?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  identify?: (value: unknown) => boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  nodeClass?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      from?: (schema: Schema, obj: unknown, ctx: CreateNodeContext) => Node;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      new (schema?: Schema): Node;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  resolve?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      value: Parsed<ParsedNode, ParsedNode> | Parsed<ParsedNode>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      onError: (message: string) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options: ParseOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  stringify?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  test?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              collection +CollectionTag | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface CollectionTag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface CollectionTag {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    collection: "map" | "seq";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createNode?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        schema: Schema,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        value: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ctx: CreateNodeContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => Node;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    default?: boolean | "key";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    format?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    identify?: (value: unknown) => boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    nodeClass?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        from?: (schema: Schema, obj: unknown, ctx: CreateNodeContext) => Node;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        new (schema?: Schema): Node;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resolve?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        value: Parsed<ParsedNode, ParsedNode> | Parsed<ParsedNode>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        onError: (message: string) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options: ParseOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    stringify?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tag: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    test?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                collection createNode? default? format? diff --git a/docs/interfaces/_internal_.CommonConnectionOptions.html b/docs/interfaces/_internal_.CommonConnectionOptions.html index b6ecf95a..921aeb34 100644 --- a/docs/interfaces/_internal_.CommonConnectionOptions.html +++ b/docs/interfaces/_internal_.CommonConnectionOptions.html @@ -1,4 +1,4 @@ -CommonConnectionOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface CommonConnectionOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface CommonConnectionOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      enableTrace?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      rejectUnauthorized?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      requestCert?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      secureContext?: SecureContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SNICallback?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          servername: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ALPNProtocols? +CommonConnectionOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface CommonConnectionOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface CommonConnectionOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        enableTrace?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rejectUnauthorized?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requestCert?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secureContext?: SecureContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SNICallback?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            servername: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ALPNProtocols? enableTrace? rejectUnauthorized? requestCert? diff --git a/docs/interfaces/_internal_.ComponentsObject.html b/docs/interfaces/_internal_.ComponentsObject.html index dd13bb57..8a3ffd6c 100644 --- a/docs/interfaces/_internal_.ComponentsObject.html +++ b/docs/interfaces/_internal_.ComponentsObject.html @@ -1,4 +1,4 @@ -ComponentsObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface ComponentsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface ComponentsObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          callbacks?: { [callback: string]: ReferenceObject | CallbackObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          examples?: { [example: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          headers?: { [header: string]: ReferenceObject | HeaderObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          links?: { [link: string]: ReferenceObject | LinkObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          parameters?: { [parameter: string]: ReferenceObject | ParameterObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pathItems?: { [pathItem: string]: ReferenceObject | PathItemObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          requestBodies?: { [request: string]: ReferenceObject | RequestBodyObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          responses?: { [response: string]: ReferenceObject | ResponseObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          schemas?: { [schema: string]: SchemaObject | ReferenceObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          securitySchemes?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [securityScheme: string]: ReferenceObject | SecuritySchemeObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      callbacks? +ComponentsObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ComponentsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ComponentsObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            callbacks?: { [callback: string]: ReferenceObject | CallbackObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            examples?: { [example: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            headers?: { [header: string]: ReferenceObject | HeaderObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            links?: { [link: string]: ReferenceObject | LinkObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            parameters?: { [parameter: string]: ReferenceObject | ParameterObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            pathItems?: { [pathItem: string]: ReferenceObject | PathItemObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            requestBodies?: { [request: string]: ReferenceObject | RequestBodyObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            responses?: { [response: string]: ReferenceObject | ResponseObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            schemas?: { [schema: string]: SchemaObject | ReferenceObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            securitySchemes?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [securityScheme: string]: ReferenceObject | SecuritySchemeObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callbacks? examples? headers? links? diff --git a/docs/interfaces/_internal_.ConfigurableSerdeContext.html b/docs/interfaces/_internal_.ConfigurableSerdeContext.html index c9b7d363..a09e5a75 100644 --- a/docs/interfaces/_internal_.ConfigurableSerdeContext.html +++ b/docs/interfaces/_internal_.ConfigurableSerdeContext.html @@ -1,4 +1,4 @@ ConfigurableSerdeContext | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ConfigurableSerdeContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Allows a protocol, codec, or serde utility to accept the serdeContext from a client configuration or request/response handlerExecutionContext.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ConfigurableSerdeContext {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setSerdeContext(serdeContext: SerdeFunctions): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          setSerdeContext +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ConfigurableSerdeContext {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setSerdeContext(serdeContext: SerdeFunctions): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          setSerdeContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.ConnectionOptions.html b/docs/interfaces/_internal_.ConnectionOptions.html index de254c04..a952f2bd 100644 --- a/docs/interfaces/_internal_.ConnectionOptions.html +++ b/docs/interfaces/_internal_.ConnectionOptions.html @@ -1,4 +1,4 @@ -ConnectionOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ConnectionOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ConnectionOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowPartialTrustChain?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ca?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cert?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                checkServerIdentity?: (hostname: string, cert: PeerCertificate) => Error;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ciphers?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                clientCertEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                crl?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                dhparam?: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ecdhCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                enableTrace?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                honorCipherOrder?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | (string | Buffer<ArrayBufferLike> | KeyObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                minDHSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                minVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                passphrase?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | (string | Buffer<ArrayBufferLike> | PxfObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                port?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                privateKeyEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                privateKeyIdentifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pskCallback?: (hint: string) => PSKCallbackNegotation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                rejectUnauthorized?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                requestCert?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                secureContext?: SecureContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                secureOptions?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                secureProtocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                servername?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                session?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sessionIdContext?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sessionTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                sigalgs?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                SNICallback?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    servername: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                socket?: Duplex;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ticketKeys?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            allowPartialTrustChain? +ConnectionOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface ConnectionOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface ConnectionOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  allowPartialTrustChain?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ALPNProtocols?: readonly string[] | ArrayBufferView<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ca?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cert?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  checkServerIdentity?: (hostname: string, cert: PeerCertificate) => Error;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ciphers?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  clientCertEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  crl?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  dhparam?: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ecdhCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  enableTrace?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  honorCipherOrder?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike> | KeyObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minDHSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  passphrase?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | (string | Buffer<ArrayBufferLike> | PxfObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  port?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  privateKeyEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  privateKeyIdentifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pskCallback?: (hint: string) => PSKCallbackNegotation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  rejectUnauthorized?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  requestCert?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secureContext?: SecureContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secureOptions?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secureProtocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  servername?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  session?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sessionIdContext?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sessionTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  sigalgs?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SNICallback?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      servername: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cb: (err: Error, ctx?: SecureContext) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  socket?: Duplex;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ticketKeys?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              allowPartialTrustChain? ALPNCallback? ALPNProtocols? ca? diff --git a/docs/interfaces/_internal_.ContactObject.html b/docs/interfaces/_internal_.ContactObject.html index f22db550..0d460112 100644 --- a/docs/interfaces/_internal_.ContactObject.html +++ b/docs/interfaces/_internal_.ContactObject.html @@ -1,4 +1,4 @@ -ContactObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface ContactObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface ContactObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    email?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    url?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                email? +ContactObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface ContactObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface ContactObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      email?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      url?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  email? name? url?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  email?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  url?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.Context.html b/docs/interfaces/_internal_.Context.html index 9eb0710a..acee8665 100644 --- a/docs/interfaces/_internal_.Context.html +++ b/docs/interfaces/_internal_.Context.html @@ -1,4 +1,4 @@ -Context | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface Context

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Handler context parameter. +Context | ts-lambda-api - v2.5.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface Context

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Handler context parameter. See AWS documentation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface Context {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          awsRequestId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          callbackWaitsForEmptyEventLoop: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clientContext?: ClientContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          functionName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          functionVersion: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          identity?: CognitoIdentity;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          invokedFunctionArn: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          logGroupName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          logStreamName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          memoryLimitInMB: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tenantId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          done(error?: Error, result?: any): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fail(error: string | Error): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getRemainingTimeInMillis(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          succeed(messageOrObject: any): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          succeed(message: string, object: any): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      awsRequestId callbackWaitsForEmptyEventLoop diff --git a/docs/interfaces/_internal_.CopyOperation.html b/docs/interfaces/_internal_.CopyOperation.html index 4e0cecd5..95f2f3e2 100644 --- a/docs/interfaces/_internal_.CopyOperation.html +++ b/docs/interfaces/_internal_.CopyOperation.html @@ -1,4 +1,4 @@ -CopyOperation | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface CopyOperation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface CopyOperation {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            from: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            op: "copy";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        from +CopyOperation | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface CopyOperation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface CopyOperation {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              from: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              op: "copy";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          from op path

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          from: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          op: "copy"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          path: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.DefaultExtensionConfiguration.html b/docs/interfaces/_internal_.DefaultExtensionConfiguration.html index 677dbc12..19d9dfa6 100644 --- a/docs/interfaces/_internal_.DefaultExtensionConfiguration.html +++ b/docs/interfaces/_internal_.DefaultExtensionConfiguration.html @@ -1,5 +1,5 @@ DefaultExtensionConfiguration | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface DefaultExtensionConfigurationInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Default extension configuration consisting various configurations for modifying a service client

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface DefaultExtensionConfiguration {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                addChecksumAlgorithm(algo: ChecksumAlgorithm): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                checksumAlgorithms(): ChecksumAlgorithm[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                retryStrategy(): Provider<RetryStrategy | RetryStrategyV2>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                setRetryStrategy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    retryStrategy: Provider<RetryStrategy | RetryStrategyV2>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [key: number]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [key: number]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            addChecksumAlgorithm +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface DefaultExtensionConfiguration {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                addChecksumAlgorithm(algo: ChecksumAlgorithm): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                checksumAlgorithms(): ChecksumAlgorithm[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                retryStrategy(): Provider<RetryStrategy | RetryStrategyV2>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                setRetryStrategy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    retryStrategy: Provider<RetryStrategy | RetryStrategyV2>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [key: number]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [key: number]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            addChecksumAlgorithm checksumAlgorithms retryStrategy setRetryStrategy diff --git a/docs/interfaces/_internal_.DeserializeHandlerOutput.html b/docs/interfaces/_internal_.DeserializeHandlerOutput.html index e638f675..110835e4 100644 --- a/docs/interfaces/_internal_.DeserializeHandlerOutput.html +++ b/docs/interfaces/_internal_.DeserializeHandlerOutput.html @@ -1,4 +1,4 @@ -DeserializeHandlerOutput | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface DeserializeHandlerOutput<Output>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface DeserializeHandlerOutput<Output extends object> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  output?: Output;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  response: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Output extends object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              output? +DeserializeHandlerOutput | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface DeserializeHandlerOutput<Output>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface DeserializeHandlerOutput<Output extends object> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    output?: Output;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    response: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Output extends object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                output? response

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                output?: Output
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                response: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                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 diff --git a/docs/interfaces/_internal_.DetailedPeerCertificate.html b/docs/interfaces/_internal_.DetailedPeerCertificate.html index f9e19686..30e51681 100644 --- a/docs/interfaces/_internal_.DetailedPeerCertificate.html +++ b/docs/interfaces/_internal_.DetailedPeerCertificate.html @@ -1,4 +1,4 @@ -DetailedPeerCertificate | ts-lambda-api - v2.5.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface DetailedPeerCertificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface DetailedPeerCertificate {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      asn1Curve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      bits?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ca: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      exponent?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ext_key_usage?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      fingerprint: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      fingerprint256: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      fingerprint512: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      infoAccess?: Dict<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      issuer: Certificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      issuerCertificate: DetailedPeerCertificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      modulus?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      nistCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pubkey?: NonSharedBuffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      raw: NonSharedBuffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      serialNumber: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      subject: Certificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      subjectaltname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      valid_from: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      valid_to: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  asn1Curve? +DetailedPeerCertificate | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface DetailedPeerCertificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface DetailedPeerCertificate {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        asn1Curve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bits?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ca: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exponent?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ext_key_usage?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fingerprint: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fingerprint256: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fingerprint512: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        infoAccess?: Dict<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        issuer: Certificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        issuerCertificate: DetailedPeerCertificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        modulus?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        nistCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pubkey?: NonSharedBuffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        raw: NonSharedBuffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serialNumber: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        subject: Certificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        subjectaltname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        valid_from: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        valid_to: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    asn1Curve? bits? ca exponent? diff --git a/docs/interfaces/_internal_.Dict.html b/docs/interfaces/_internal_.Dict.html index 4a75b23c..20b76878 100644 --- a/docs/interfaces/_internal_.Dict.html +++ b/docs/interfaces/_internal_.Dict.html @@ -1 +1 @@ -Dict | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface Dict<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [key: string]: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +Dict | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface Dict<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [key: string]: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.Document.Parsed.html b/docs/interfaces/_internal_.Document.Parsed.html index fea3070d..a6bfad56 100644 --- a/docs/interfaces/_internal_.Document.Parsed.html +++ b/docs/interfaces/_internal_.Document.Parsed.html @@ -1,5 +1,5 @@ Parsed | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface Parsed<Contents, Strict>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          The typing of directives fails in TS <= 4.2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface Parsed<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Contents extends ParsedNode = ParsedNode,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Strict extends boolean = true,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          > {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              comment: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              commentBefore: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              contents: Strict extends true ? Contents : Contents;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              directives: Directives;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              errors: YAMLError[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options: Required<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Omit<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ParseOptions & DocumentOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "_directives"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "lineCounter"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "version",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  >,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              >;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              schema: Schema;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              warnings: YAMLWarning[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              add(value: any): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              addIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              clone(): Document<Contents, Strict>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createAlias(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  node: Strict extends true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ? Scalar<unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | YAMLMap<unknown, unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | YAMLSeq<unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      : Node,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Alias;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createNode<T = unknown>(value: T, options?: CreateNodeOptions): NodeType<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createNode<T = unknown>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  replacer: Replacer | CreateNodeOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options?: CreateNodeOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): NodeType<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createPair<K extends Node = Node, V extends Node = Node>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  key: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options?: CreateNodeOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Pair<K, V>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              delete(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              deleteIn(path: Iterable<unknown, any, any>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              get(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  key: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keepScalar?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Strict extends true ? unknown : any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getIn(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  path: Iterable<unknown, any, any>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keepScalar?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Strict extends true ? unknown : any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              has(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hasIn(path: Iterable<unknown, any, any>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              set(key: any, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setIn(path: Iterable<unknown, any, any>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setSchema(version: "1.1" | "1.2" | "next", options?: SchemaOptions): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              toJS(opt?: ToJSOptions & { [ignored: string]: unknown }): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              toJSON(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  jsonArg?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onAnchor?: (value: unknown, count: number) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              toString(options?: ToStringOptions): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [NODE_TYPE] +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface Parsed<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Contents extends ParsedNode = ParsedNode,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Strict extends boolean = true,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          > {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              comment: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              commentBefore: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              contents: Strict extends true ? Contents : Contents;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              directives: Directives;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              errors: YAMLError[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options: Required<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Omit<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ParseOptions & DocumentOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "_directives"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "lineCounter"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "version",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  >,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              >;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              schema: Schema;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              warnings: YAMLWarning[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              add(value: any): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              addIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              clone(): Document<Contents, Strict>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createAlias(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  node: Strict extends true
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ? Scalar<unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | YAMLMap<unknown, unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | YAMLSeq<unknown>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      : Node,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Alias;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createNode<T = unknown>(value: T, options?: CreateNodeOptions): NodeType<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createNode<T = unknown>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  replacer: Replacer | CreateNodeOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options?: CreateNodeOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): NodeType<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createPair<K extends Node = Node, V extends Node = Node>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  key: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options?: CreateNodeOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Pair<K, V>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              delete(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              deleteIn(path: Iterable<unknown, any, any>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              get(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  key: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keepScalar?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Strict extends true ? unknown : any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getIn(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  path: Iterable<unknown, any, any>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keepScalar?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Strict extends true ? unknown : any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              has(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              hasIn(path: Iterable<unknown, any, any>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              set(key: any, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setIn(path: Iterable<unknown, any, any>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setSchema(version: "1.1" | "1.2" | "next", options?: SchemaOptions): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              toJS(opt?: ToJSOptions & { [ignored: string]: unknown }): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              toJSON(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  jsonArg?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onAnchor?: (value: unknown, count: number) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              toString(options?: ToStringOptions): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [NODE_TYPE] comment commentBefore contents diff --git a/docs/interfaces/_internal_.EncodingObject.html b/docs/interfaces/_internal_.EncodingObject.html index f1ffaa7b..0190e10c 100644 --- a/docs/interfaces/_internal_.EncodingObject.html +++ b/docs/interfaces/_internal_.EncodingObject.html @@ -1 +1 @@ -EncodingObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface EncodingObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [property: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [extensionName: `x-${string}`]: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +EncodingObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface EncodingObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [property: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [extensionName: `x-${string}`]: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.EndpointParameters.html b/docs/interfaces/_internal_.EndpointParameters.html index 1345a627..b5ccb5ce 100644 --- a/docs/interfaces/_internal_.EndpointParameters.html +++ b/docs/interfaces/_internal_.EndpointParameters.html @@ -1,4 +1,4 @@ -EndpointParameters | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface EndpointParametersInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface EndpointParameters {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Accelerate?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Bucket?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CopySource?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DisableAccessPoints?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DisableMultiRegionAccessPoints?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    DisableS3ExpressSessionAuth?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Endpoint?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ForcePathStyle?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Key?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Prefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Region?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UseArnRegion?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UseDualStack?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UseFIPS?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UseGlobalEndpoint?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UseObjectLambdaEndpoint?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UseS3ExpressControlEndpoint?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [name: string]: string | boolean | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [name: string]: string | boolean | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Accelerate? +EndpointParameters | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface EndpointParametersInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface EndpointParameters {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Accelerate?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Bucket?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CopySource?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DisableAccessPoints?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DisableMultiRegionAccessPoints?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      DisableS3ExpressSessionAuth?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Endpoint?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ForcePathStyle?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Key?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Prefix?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Region?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UseArnRegion?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UseDualStack?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UseFIPS?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UseGlobalEndpoint?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UseObjectLambdaEndpoint?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UseS3ExpressControlEndpoint?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [name: string]: string | boolean | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [name: string]: string | boolean | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Accelerate? Bucket? CopySource? DisableAccessPoints? diff --git a/docs/interfaces/_internal_.ErrnoException.html b/docs/interfaces/_internal_.ErrnoException.html index 75fc96d6..52e460e4 100644 --- a/docs/interfaces/_internal_.ErrnoException.html +++ b/docs/interfaces/_internal_.ErrnoException.html @@ -1,4 +1,4 @@ -ErrnoException | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface ErrnoException

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface ErrnoException {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cause?: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        code?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        errno?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        message: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        stack?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        syscall?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Error
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ErrnoException
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cause? +ErrnoException | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface ErrnoException

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface ErrnoException {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cause?: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          code?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          errno?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          message: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          stack?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          syscall?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Error
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • ErrnoException
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cause? code? errno? message diff --git a/docs/interfaces/_internal_.Event.html b/docs/interfaces/_internal_.Event.html index fdf48eb5..ffd4ae8e 100644 --- a/docs/interfaces/_internal_.Event.html +++ b/docs/interfaces/_internal_.Event.html @@ -1,4 +1,4 @@ -Event | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface Event

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface Event {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            bubbles: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cancelable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cancelBubble: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            composed: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            currentTarget: EventTarget;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            defaultPrevented: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            eventPhase: 0 | 2;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            isTrusted: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            returnValue: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            srcElement: EventTarget;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            target: EventTarget;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            timeStamp: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            composedPath(): [EventTarget?];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            preventDefault(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stopImmediatePropagation(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stopPropagation(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bubbles +Event | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface Event

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface Event {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              bubbles: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cancelable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cancelBubble: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              composed: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              currentTarget: EventTarget;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              defaultPrevented: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              eventPhase: 0 | 2;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              isTrusted: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              returnValue: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              srcElement: EventTarget;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              target: EventTarget;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              timeStamp: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              composedPath(): [EventTarget?];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              preventDefault(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stopImmediatePropagation(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stopPropagation(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          bubbles cancelable cancelBubble composed diff --git a/docs/interfaces/_internal_.EventEmitter.Abortable.html b/docs/interfaces/_internal_.EventEmitter.Abortable.html index e7d9e36e..f9199dee 100644 --- a/docs/interfaces/_internal_.EventEmitter.Abortable.html +++ b/docs/interfaces/_internal_.EventEmitter.Abortable.html @@ -1,3 +1,3 @@ -Abortable | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface Abortable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface Abortable {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signal? +Abortable | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface Abortable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface Abortable {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signal?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              signal?: AbortSignal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              When provided the corresponding AbortController can be used to cancel an asynchronous action.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html b/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html index cc31e913..e1424154 100644 --- a/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html +++ b/docs/interfaces/_internal_.EventEmitter.EventEmitterAsyncResourceOptions.html @@ -1,4 +1,4 @@ -EventEmitterAsyncResourceOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface EventEmitterAsyncResourceOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface EventEmitterAsyncResourceOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    captureRejections?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    requireManualDestroy?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    triggerAsyncId?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                captureRejections? +EventEmitterAsyncResourceOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface EventEmitterAsyncResourceOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface EventEmitterAsyncResourceOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      captureRejections?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      requireManualDestroy?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      triggerAsyncId?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  captureRejections? name? requireManualDestroy? triggerAsyncId? diff --git a/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html b/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html index 742f7967..7a8a8a3e 100644 --- a/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html +++ b/docs/interfaces/_internal_.EventEmitter.EventEmitterReferencingAsyncResource.html @@ -6,7 +6,7 @@ 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  import { AsyncResource, executionAsyncId } from 'node:async_hooks';

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // AsyncResource() is meant to be extended. Instantiating a
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // new AsyncResource() also triggers init. If triggerAsyncId is omitted then
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // async_hook.executionAsyncId() is used.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  const asyncResource = new AsyncResource(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type, { triggerAsyncId: executionAsyncId(), requireManualDestroy: false },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  );

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Run a function in the execution context of the resource. This will
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // * establish the context of the resource
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // * trigger the AsyncHooks before callbacks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // * call the provided function `fn` with the supplied arguments
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // * trigger the AsyncHooks after callbacks
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // * restore the original execution context
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  asyncResource.runInAsyncScope(fn, thisArg, ...args);

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Call AsyncHooks destroy callbacks.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  asyncResource.emitDestroy();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Return the unique ID assigned to the AsyncResource instance.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  asyncResource.asyncId();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // Return the trigger ID for the AsyncResource instance.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  asyncResource.triggerAsyncId();
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface EventEmitterReferencingAsyncResource {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      eventEmitter: EventEmitterAsyncResource;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      asyncId(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      bind<Func extends (...args: any[]) => any>(fn: Func): Func;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      emitDestroy(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      runInAsyncScope<This, Result>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fn: (this: This, ...args: any[]) => Result,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          thisArg?: This,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ...args: any[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Result;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      triggerAsyncId(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  eventEmitter +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface EventEmitterReferencingAsyncResource {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      eventEmitter: EventEmitterAsyncResource;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      asyncId(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      bind<Func extends (...args: any[]) => any>(fn: Func): Func;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      emitDestroy(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      runInAsyncScope<This, Result>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fn: (this: This, ...args: any[]) => Result,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          thisArg?: This,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ...args: any[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Result;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      triggerAsyncId(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  eventEmitter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  asyncId bind emitDestroy diff --git a/docs/interfaces/_internal_.EventEmitter.NodeEventTarget.html b/docs/interfaces/_internal_.EventEmitter.NodeEventTarget.html index 19a3b3fa..1bd8431b 100644 --- a/docs/interfaces/_internal_.EventEmitter.NodeEventTarget.html +++ b/docs/interfaces/_internal_.EventEmitter.NodeEventTarget.html @@ -1,7 +1,7 @@ NodeEventTarget | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface NodeEventTarget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The NodeEventTarget is a Node.js-specific extension to EventTarget that emulates a subset of the EventEmitter API.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    v14.5.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface NodeEventTarget {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        addEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: boolean | AddEventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        addListener(type: string, listener: (arg: any) => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        dispatchEvent(event: Event): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        emit(type: string, arg: any): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventNames(): string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getMaxListeners(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listenerCount(type: string): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        off(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (arg: any) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: EventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        on(type: string, listener: (arg: any) => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        once(type: string, listener: (arg: any) => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        removeAllListeners(type?: string): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        removeEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: boolean | EventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        removeListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (arg: any) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: EventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setMaxListeners(n: number): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addEventListener +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface NodeEventTarget {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        addEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: boolean | AddEventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        addListener(type: string, listener: (arg: any) => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        dispatchEvent(event: Event): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        emit(type: string, arg: any): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventNames(): string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getMaxListeners(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listenerCount(type: string): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        off(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (arg: any) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: EventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        on(type: string, listener: (arg: any) => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        once(type: string, listener: (arg: any) => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        removeAllListeners(type?: string): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        removeEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: boolean | EventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        removeListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (arg: any) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: EventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setMaxListeners(n: number): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addEventListener addListener dispatchEvent emit diff --git a/docs/interfaces/_internal_.EventEmitter.html b/docs/interfaces/_internal_.EventEmitter.html index 866a1b4b..492a2b75 100644 --- a/docs/interfaces/_internal_.EventEmitter.html +++ b/docs/interfaces/_internal_.EventEmitter.html @@ -1,4 +1,4 @@ -EventEmitter | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface EventEmitter<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface EventEmitter<T extends EventMap<T> = DefaultEventMap> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[captureRejectionSymbol]"?<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              event: Key<K, T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ...args: Args<K, T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          addListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          emit<K>(eventName: Key<K, T>, ...args: Args<K, T>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventNames(): ((string | symbol) & Key2<unknown, T>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getMaxListeners(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listenerCount<K>(eventName: Key<K, T>, listener?: Listener<K, T>): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listeners<K>(eventName: Key<K, T>): Listener<K, T, Function>[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          off<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          on<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          once<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          prependListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          prependOnceListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              eventName: Key<K, T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              listener: Listener<K, T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          rawListeners<K>(eventName: Key<K, T>): Listener<K, T, Function>[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          removeAllListeners(eventName?: Key<unknown, T>): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          removeListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          setMaxListeners(n: number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [captureRejectionSymbol]? +EventEmitter | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface EventEmitter<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface EventEmitter<T extends EventMap<T> = DefaultEventMap> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[captureRejectionSymbol]"?<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                event: Key<K, T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ...args: Args<K, T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            addListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            emit<K>(eventName: Key<K, T>, ...args: Args<K, T>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            eventNames(): ((string | symbol) & Key2<unknown, T>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getMaxListeners(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listenerCount<K>(eventName: Key<K, T>, listener?: Listener<K, T>): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listeners<K>(eventName: Key<K, T>): Listener<K, T, Function>[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            off<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            on<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            once<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            prependListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            prependOnceListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                eventName: Key<K, T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                listener: Listener<K, T>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            rawListeners<K>(eventName: Key<K, T>): Listener<K, T, Function>[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            removeAllListeners(eventName?: Key<unknown, T>): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            removeListener<K>(eventName: Key<K, T>, listener: Listener<K, T>): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setMaxListeners(n: number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [captureRejectionSymbol]? addListener emit eventNames diff --git a/docs/interfaces/_internal_.EventEmitterOptions.html b/docs/interfaces/_internal_.EventEmitterOptions.html index 072a6338..3c20b024 100644 --- a/docs/interfaces/_internal_.EventEmitterOptions.html +++ b/docs/interfaces/_internal_.EventEmitterOptions.html @@ -1,3 +1,3 @@ -EventEmitterOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface EventEmitterOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface EventEmitterOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              captureRejections?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          captureRejections? +EventEmitterOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface EventEmitterOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface EventEmitterOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                captureRejections?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            captureRejections?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            captureRejections?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Enables automatic capturing of promise rejection.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.EventListenerOptions-1.html b/docs/interfaces/_internal_.EventListenerOptions-1.html index 9fca58b4..518412d6 100644 --- a/docs/interfaces/_internal_.EventListenerOptions-1.html +++ b/docs/interfaces/_internal_.EventListenerOptions-1.html @@ -1,2 +1,2 @@ -EventListenerOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface EventListenerOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface EventListenerOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  capture?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              capture? +EventListenerOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface EventListenerOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface EventListenerOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    capture?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                capture?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                capture?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.EventListenerOptions.html b/docs/interfaces/_internal_.EventListenerOptions.html index 321460ea..9273384a 100644 --- a/docs/interfaces/_internal_.EventListenerOptions.html +++ b/docs/interfaces/_internal_.EventListenerOptions.html @@ -1,2 +1,2 @@ -EventListenerOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface EventListenerOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface EventListenerOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      capture?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  capture? +EventListenerOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface EventListenerOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface EventListenerOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        capture?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    capture?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    capture?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.EventTarget.html b/docs/interfaces/_internal_.EventTarget.html index 36fab03f..0824e55c 100644 --- a/docs/interfaces/_internal_.EventTarget.html +++ b/docs/interfaces/_internal_.EventTarget.html @@ -1,4 +1,4 @@ -EventTarget | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface EventTarget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface EventTarget {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          addEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: boolean | AddEventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          dispatchEvent(event: Event): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          removeEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: boolean | EventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      addEventListener +EventTarget | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface EventTarget

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface EventTarget {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            addEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                options?: boolean | AddEventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            dispatchEvent(event: Event): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            removeEventListener(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                listener: EventListener | EventListenerObject,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                options?: boolean | EventListenerOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        addEventListener dispatchEvent removeEventListener

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.ExternalDocumentationObject.html b/docs/interfaces/_internal_.ExternalDocumentationObject.html index 93373738..ec0db3cc 100644 --- a/docs/interfaces/_internal_.ExternalDocumentationObject.html +++ b/docs/interfaces/_internal_.ExternalDocumentationObject.html @@ -1,3 +1,3 @@ -ExternalDocumentationObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ExternalDocumentationObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ExternalDocumentationObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              url: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description? +ExternalDocumentationObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ExternalDocumentationObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ExternalDocumentationObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                url: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description? url

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            url: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.FinalizeHandlerArguments.html b/docs/interfaces/_internal_.FinalizeHandlerArguments.html index ed55faaa..2200bc18 100644 --- a/docs/interfaces/_internal_.FinalizeHandlerArguments.html +++ b/docs/interfaces/_internal_.FinalizeHandlerArguments.html @@ -1,4 +1,4 @@ -FinalizeHandlerArguments | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface FinalizeHandlerArguments<Input>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface FinalizeHandlerArguments<Input extends object> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  input: Input;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  request: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Input extends object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              input +FinalizeHandlerArguments | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface FinalizeHandlerArguments<Input>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface FinalizeHandlerArguments<Input extends object> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    input: Input;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    request: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Input extends object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                input request

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                input: Input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                User input to a command. Reflects the userland representation of the union of data types the command can effectively handle.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.FinalizeHandlerOutput.html b/docs/interfaces/_internal_.FinalizeHandlerOutput.html index a6151a6b..de65868b 100644 --- a/docs/interfaces/_internal_.FinalizeHandlerOutput.html +++ b/docs/interfaces/_internal_.FinalizeHandlerOutput.html @@ -1,4 +1,4 @@ -FinalizeHandlerOutput | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface FinalizeHandlerOutput<Output>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface FinalizeHandlerOutput<Output extends object> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      output: Output;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      response: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Output extends object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  output +FinalizeHandlerOutput | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface FinalizeHandlerOutput<Output>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface FinalizeHandlerOutput<Output extends object> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        output: Output;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        response: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Output extends object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    output response

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    output: Output
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    response: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    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 diff --git a/docs/interfaces/_internal_.Generator.html b/docs/interfaces/_internal_.Generator.html index 73427056..d8e14113 100644 --- a/docs/interfaces/_internal_.Generator.html +++ b/docs/interfaces/_internal_.Generator.html @@ -1,4 +1,4 @@ -Generator | ts-lambda-api - v2.5.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface Generator<T, TReturn, TNext>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface Generator<T = unknown, TReturn = any, TNext = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[dispose]"(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[iterator]"(): Generator<T, TReturn, TNext>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          next(...__namedParameters: [] | [TNext]): IteratorResult<T, TReturn>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          return(value: TReturn): IteratorResult<T, TReturn>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throw(e: any): IteratorResult<T, TReturn>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T = unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • TReturn = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • TNext = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [dispose] +Generator | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface Generator<T, TReturn, TNext>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface Generator<T = unknown, TReturn = any, TNext = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[dispose]"(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[iterator]"(): Generator<T, TReturn, TNext>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            next(...__namedParameters: [] | [TNext]): IteratorResult<T, TReturn>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            return(value: TReturn): IteratorResult<T, TReturn>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throw(e: any): IteratorResult<T, TReturn>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T = unknown
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • TReturn = any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • TNext = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [dispose] [iterator] next return diff --git a/docs/interfaces/_internal_.GetAllOptions.html b/docs/interfaces/_internal_.GetAllOptions.html index c2dd7387..7908661a 100644 --- a/docs/interfaces/_internal_.GetAllOptions.html +++ b/docs/interfaces/_internal_.GetAllOptions.html @@ -1,4 +1,4 @@ -GetAllOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface GetAllOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface GetAllOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autobind?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              chained?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              optional?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              tag?: GetOptionsTagConstraint;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          autobind? +GetAllOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface GetAllOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface GetAllOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                autobind?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                chained?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                optional?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tag?: GetOptionsTagConstraint;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            autobind? chained? name? optional? diff --git a/docs/interfaces/_internal_.GetOperation.html b/docs/interfaces/_internal_.GetOperation.html index 2e3f1b83..40dbd721 100644 --- a/docs/interfaces/_internal_.GetOperation.html +++ b/docs/interfaces/_internal_.GetOperation.html @@ -1,4 +1,4 @@ -GetOperation | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface GetOperation<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface GetOperation<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  op: "_get";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              op +GetOperation | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface GetOperation<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface GetOperation<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    op: "_get";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    value: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                op path value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                op: "_get"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                path: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                value: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.GetOptions.html b/docs/interfaces/_internal_.GetOptions.html index 3b7b4f13..f4594ad0 100644 --- a/docs/interfaces/_internal_.GetOptions.html +++ b/docs/interfaces/_internal_.GetOptions.html @@ -1,4 +1,4 @@ -GetOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface GetOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface GetOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      autobind?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      optional?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tag?: GetOptionsTagConstraint;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  autobind? +GetOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface GetOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface GetOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        autobind?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        optional?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tag?: GetOptionsTagConstraint;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    autobind? name? optional? tag? diff --git a/docs/interfaces/_internal_.HeaderObject.html b/docs/interfaces/_internal_.HeaderObject.html index 8f1b2f34..5458fee4 100644 --- a/docs/interfaces/_internal_.HeaderObject.html +++ b/docs/interfaces/_internal_.HeaderObject.html @@ -1,4 +1,4 @@ -HeaderObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface HeaderObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface HeaderObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          $ref?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allowEmptyValue?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allowReserved?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          content?: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          example?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          examples?: { [param: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          explode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          required?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          style?: ParameterStyle;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      $ref? +HeaderObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface HeaderObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface HeaderObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            $ref?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            allowEmptyValue?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            allowReserved?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            content?: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            example?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            examples?: { [param: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            explode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            required?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            style?: ParameterStyle;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        $ref? allowEmptyValue? allowReserved? content? diff --git a/docs/interfaces/_internal_.Headers.html b/docs/interfaces/_internal_.Headers.html index a000de2e..19af6446 100644 --- a/docs/interfaces/_internal_.Headers.html +++ b/docs/interfaces/_internal_.Headers.html @@ -1,4 +1,4 @@ -Headers | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface Headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface Headers {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "[iterator]": () => SpecIterableIterator<[string, string]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              append: (name: string, value: string) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              delete: (name: string) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              entries: () => SpecIterableIterator<[string, string]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              forEach: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  callbackfn: (value: string, key: string, iterable: Headers) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  thisArg?: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              get: (name: string) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getSetCookie: () => string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              has: (name: string) => boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keys: () => SpecIterableIterator<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              set: (name: string, value: string) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              values: () => SpecIterableIterator<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [iterator] +Headers | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface Headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface Headers {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "[iterator]": () => SpecIterableIterator<[string, string]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                append: (name: string, value: string) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                delete: (name: string) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                entries: () => SpecIterableIterator<[string, string]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                forEach: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    callbackfn: (value: string, key: string, iterable: Headers) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    thisArg?: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                get: (name: string) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getSetCookie: () => string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                has: (name: string) => boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                keys: () => SpecIterableIterator<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                set: (name: string, value: string) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                values: () => SpecIterableIterator<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [iterator] append delete entries diff --git a/docs/interfaces/_internal_.HttpAuthExtensionConfiguration.html b/docs/interfaces/_internal_.HttpAuthExtensionConfiguration.html index 53b3ee61..be3d4cb6 100644 --- a/docs/interfaces/_internal_.HttpAuthExtensionConfiguration.html +++ b/docs/interfaces/_internal_.HttpAuthExtensionConfiguration.html @@ -1,4 +1,4 @@ -HttpAuthExtensionConfiguration | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface HttpAuthExtensionConfigurationInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface HttpAuthExtensionConfiguration {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  credentials(): AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpAuthSchemeProvider(): S3HttpAuthSchemeProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpAuthSchemes(): HttpAuthScheme[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  setCredentials(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  setHttpAuthSchemeProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpAuthSchemeProvider: S3HttpAuthSchemeProvider,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              credentials +HttpAuthExtensionConfiguration | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface HttpAuthExtensionConfigurationInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface HttpAuthExtensionConfiguration {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    credentials(): AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    httpAuthSchemeProvider(): S3HttpAuthSchemeProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    httpAuthSchemes(): HttpAuthScheme[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setCredentials(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setHttpAuthScheme(httpAuthScheme: HttpAuthScheme): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setHttpAuthSchemeProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        httpAuthSchemeProvider: S3HttpAuthSchemeProvider,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                credentials httpAuthSchemeProvider httpAuthSchemes setCredentials diff --git a/docs/interfaces/_internal_.HttpAuthSchemeInputConfig.html b/docs/interfaces/_internal_.HttpAuthSchemeInputConfig.html index 2d382f50..0a87fb28 100644 --- a/docs/interfaces/_internal_.HttpAuthSchemeInputConfig.html +++ b/docs/interfaces/_internal_.HttpAuthSchemeInputConfig.html @@ -1,4 +1,4 @@ -HttpAuthSchemeInputConfig | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface HttpAuthSchemeInputConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface HttpAuthSchemeInputConfig {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      authSchemePreference?: string[] | Provider<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpAuthSchemeProvider?: S3HttpAuthSchemeProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      httpAuthSchemes?: HttpAuthScheme[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signer?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | RequestSigner
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | ((authScheme?: AuthScheme) => Promise<RequestSigner>);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signerConstructor?: new (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => RequestSigner;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signingEscapePath?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signingRegion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sigv4aSigningRegionSet?: string[] | Provider<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      systemClockOffset?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  authSchemePreference? +HttpAuthSchemeInputConfig | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface HttpAuthSchemeInputConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface HttpAuthSchemeInputConfig {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        authSchemePreference?: string[] | Provider<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        credentials?: AwsCredentialIdentity | AwsCredentialIdentityProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        httpAuthSchemeProvider?: S3HttpAuthSchemeProvider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        httpAuthSchemes?: HttpAuthScheme[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signer?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | RequestSigner
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | ((authScheme?: AuthScheme) => Promise<RequestSigner>);
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signerConstructor?: new (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options: SignatureV4Init & SignatureV4CryptoInit,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => RequestSigner;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingEscapePath?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signingRegion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sigv4aSigningRegionSet?: string[] | Provider<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        systemClockOffset?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    authSchemePreference? credentials? httpAuthSchemeProvider? httpAuthSchemes? diff --git a/docs/interfaces/_internal_.HttpAuthSchemeParameters.html b/docs/interfaces/_internal_.HttpAuthSchemeParameters.html index b2c5c266..93d213e1 100644 --- a/docs/interfaces/_internal_.HttpAuthSchemeParameters.html +++ b/docs/interfaces/_internal_.HttpAuthSchemeParameters.html @@ -1,2 +1,2 @@ -HttpAuthSchemeParameters | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface HttpAuthSchemeParametersInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface HttpAuthSchemeParameters {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          operation?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      operation? +HttpAuthSchemeParameters | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface HttpAuthSchemeParametersInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface HttpAuthSchemeParameters {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            operation?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        operation?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        operation?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.HttpAuthSchemeProvider.html b/docs/interfaces/_internal_.HttpAuthSchemeProvider.html index f26904b5..113003f9 100644 --- a/docs/interfaces/_internal_.HttpAuthSchemeProvider.html +++ b/docs/interfaces/_internal_.HttpAuthSchemeProvider.html @@ -1 +1 @@ -HttpAuthSchemeProvider | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface HttpAuthSchemeProvider<TParameters>Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +HttpAuthSchemeProvider | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface HttpAuthSchemeProvider<TParameters>Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.HttpHandlerExtensionConfiguration.html b/docs/interfaces/_internal_.HttpHandlerExtensionConfiguration.html index 474341e3..530ed385 100644 --- a/docs/interfaces/_internal_.HttpHandlerExtensionConfiguration.html +++ b/docs/interfaces/_internal_.HttpHandlerExtensionConfiguration.html @@ -1,4 +1,4 @@ -HttpHandlerExtensionConfiguration | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface HttpHandlerExtensionConfiguration<HandlerConfig>Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface HttpHandlerExtensionConfiguration<HandlerConfig extends object = {}> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpHandler(): HttpHandler<HandlerConfig>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  httpHandlerConfigs(): HandlerConfig;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  setHttpHandler(handler: HttpHandler<HandlerConfig>): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  updateHttpClientConfig(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      key: keyof HandlerConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      value: HandlerConfig[keyof HandlerConfig],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • HandlerConfig extends object = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              httpHandler +HttpHandlerExtensionConfiguration | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface HttpHandlerExtensionConfiguration<HandlerConfig>Internal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface HttpHandlerExtensionConfiguration<HandlerConfig extends object = {}> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    httpHandler(): HttpHandler<HandlerConfig>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    httpHandlerConfigs(): HandlerConfig;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setHttpHandler(handler: HttpHandler<HandlerConfig>): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateHttpClientConfig(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        key: keyof HandlerConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        value: HandlerConfig[keyof HandlerConfig],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • HandlerConfig extends object = {}

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                httpHandler httpHandlerConfigs setHttpHandler updateHttpClientConfig diff --git a/docs/interfaces/_internal_.HttpMessage.html b/docs/interfaces/_internal_.HttpMessage.html index 5a53fd32..9267bdc9 100644 --- a/docs/interfaces/_internal_.HttpMessage.html +++ b/docs/interfaces/_internal_.HttpMessage.html @@ -1,5 +1,5 @@ HttpMessage | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface HttpMessage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Represents an HTTP message with headers and an optional static or streaming body. body: ArrayBuffer | ArrayBufferView | string | Uint8Array | Readable | ReadableStream;

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface HttpMessage {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      body?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      headers: HeaderBag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  body? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface HttpMessage {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      body?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      headers: HeaderBag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  body? headers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optionalbody

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  body?: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  headers: HeaderBag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.HttpRequest.html b/docs/interfaces/_internal_.HttpRequest.html index 2af78e9d..36f9ce2e 100644 --- a/docs/interfaces/_internal_.HttpRequest.html +++ b/docs/interfaces/_internal_.HttpRequest.html @@ -1,6 +1,6 @@ HttpRequest | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface HttpRequest

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface an HTTP request class. Contains addressing information in addition to standard message properties.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface HttpRequest {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        body?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fragment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        headers: HeaderBag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hostname: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        method: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        password?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        port?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        protocol: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        query?: QueryParameterBag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        username?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    body? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface HttpRequest {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        body?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fragment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        headers: HeaderBag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hostname: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        method: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        password?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        port?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        protocol: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        query?: QueryParameterBag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        username?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    body? fragment? headers hostname diff --git a/docs/interfaces/_internal_.HttpResponse.html b/docs/interfaces/_internal_.HttpResponse.html index 5a6e92b8..fa12df53 100644 --- a/docs/interfaces/_internal_.HttpResponse.html +++ b/docs/interfaces/_internal_.HttpResponse.html @@ -1,6 +1,6 @@ HttpResponse | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface HttpResponse

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Represents an HTTP message as received in reply to a request. Contains a numeric status code in addition to standard message properties.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface HttpResponse {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          body?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          headers: HeaderBag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reason?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          statusCode: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      body? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface HttpResponse {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          body?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          headers: HeaderBag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          reason?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          statusCode: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      body? headers reason? statusCode diff --git a/docs/interfaces/_internal_.IParameterExtractor.html b/docs/interfaces/_internal_.IParameterExtractor.html index 975eb380..e2d097f4 100644 --- a/docs/interfaces/_internal_.IParameterExtractor.html +++ b/docs/interfaces/_internal_.IParameterExtractor.html @@ -1,6 +1,6 @@ -IParameterExtractor | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface IParameterExtractor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface IParameterExtractor {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            apiParamInfo?: ApiParam;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            source: ParameterSource;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            extract(request: Request, response: Response, user: Principal): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setLogger(logFactory: LogFactory): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        apiParamInfo? +IParameterExtractor | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface IParameterExtractor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface IParameterExtractor {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              apiParamInfo?: ApiParam;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              source: ParameterSource;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              extract(request: Request, response: Response, user: Principal): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setLogger(logFactory: LogFactory): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          apiParamInfo? name source

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          extract setLogger -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          apiParamInfo?: ApiParam
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          source: ParameterSource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          apiParamInfo?: ApiParam
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          source: ParameterSource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.Identity.html b/docs/interfaces/_internal_.Identity.html index 69fc6fce..95379b61 100644 --- a/docs/interfaces/_internal_.Identity.html +++ b/docs/interfaces/_internal_.Identity.html @@ -1,3 +1,3 @@ -Identity | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface Identity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface Identity {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                expiration?: Date;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            expiration? +Identity | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface Identity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface Identity {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  expiration?: Date;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              expiration?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              expiration?: Date

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              A Date when the identity or credential will no longer be accepted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/_internal_.IncomingHttpHeaders.html b/docs/interfaces/_internal_.IncomingHttpHeaders.html index c1ca100f..3bc77c90 100644 --- a/docs/interfaces/_internal_.IncomingHttpHeaders.html +++ b/docs/interfaces/_internal_.IncomingHttpHeaders.html @@ -1,4 +1,4 @@ -IncomingHttpHeaders | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface IncomingHttpHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface IncomingHttpHeaders {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    accept?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "accept-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "accept-language"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "accept-patch"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "accept-ranges"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "access-control-allow-credentials"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "access-control-allow-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "access-control-allow-methods"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "access-control-allow-origin"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "access-control-expose-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "access-control-max-age"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "access-control-request-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "access-control-request-method"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    age?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    allow?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "alt-svc"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    authorization?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "cache-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    connection?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "content-disposition"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "content-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "content-language"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "content-length"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "content-location"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "content-range"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "content-type"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cookie?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    date?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    etag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    expect?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    expires?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    forwarded?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    from?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "if-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "if-modified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "if-none-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "if-unmodified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "last-modified"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    location?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    origin?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pragma?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "proxy-authenticate"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "proxy-authorization"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "public-key-pins"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    range?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    referer?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "retry-after"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "sec-fetch-dest"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "sec-fetch-mode"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "sec-fetch-site"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "sec-fetch-user"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "sec-websocket-accept"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "sec-websocket-extensions"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "sec-websocket-key"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "sec-websocket-protocol"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "sec-websocket-version"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "set-cookie"?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "strict-transport-security"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tk?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    trailer?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "transfer-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    upgrade?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "user-agent"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    vary?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    via?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    warning?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "www-authenticate"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [key: string]: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Dict<string | string[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • IncomingHttpHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [key: string]: string | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                accept? +IncomingHttpHeaders | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface IncomingHttpHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface IncomingHttpHeaders {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      accept?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "accept-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "accept-language"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "accept-patch"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "accept-ranges"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "access-control-allow-credentials"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "access-control-allow-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "access-control-allow-methods"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "access-control-allow-origin"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "access-control-expose-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "access-control-max-age"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "access-control-request-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "access-control-request-method"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      age?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      allow?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "alt-svc"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      authorization?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "cache-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      connection?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "content-disposition"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "content-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "content-language"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "content-length"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "content-location"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "content-range"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "content-type"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cookie?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      date?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      etag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      expect?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      expires?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      forwarded?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      from?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "if-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "if-modified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "if-none-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "if-unmodified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "last-modified"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      location?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      origin?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pragma?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "proxy-authenticate"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "proxy-authorization"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "public-key-pins"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      range?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      referer?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "retry-after"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "sec-fetch-dest"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "sec-fetch-mode"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "sec-fetch-site"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "sec-fetch-user"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "sec-websocket-accept"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "sec-websocket-extensions"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "sec-websocket-key"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "sec-websocket-protocol"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "sec-websocket-version"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "set-cookie"?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "strict-transport-security"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tk?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      trailer?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "transfer-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      upgrade?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "user-agent"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      vary?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      via?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      warning?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "www-authenticate"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [key: string]: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Dict<string | string[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • IncomingHttpHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [key: string]: string | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  accept? accept-encoding? accept-language? accept-patch? diff --git a/docs/interfaces/_internal_.InfoObject.html b/docs/interfaces/_internal_.InfoObject.html index a132a392..11c72324 100644 --- a/docs/interfaces/_internal_.InfoObject.html +++ b/docs/interfaces/_internal_.InfoObject.html @@ -1,4 +1,4 @@ -InfoObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface InfoObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface InfoObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        contact?: ContactObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        license?: LicenseObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        termsOfService?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        title: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        version: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    contact? +InfoObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface InfoObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface InfoObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          contact?: ContactObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          license?: LicenseObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          termsOfService?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          title: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          version: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      contact? description? license? termsOfService? diff --git a/docs/interfaces/_internal_.InitializeHandlerArguments.html b/docs/interfaces/_internal_.InitializeHandlerArguments.html index 42363ab1..4728a8a0 100644 --- a/docs/interfaces/_internal_.InitializeHandlerArguments.html +++ b/docs/interfaces/_internal_.InitializeHandlerArguments.html @@ -1,4 +1,4 @@ -InitializeHandlerArguments | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface InitializeHandlerArguments<Input>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface InitializeHandlerArguments<Input extends object> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            input: Input;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Input extends object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        input +InitializeHandlerArguments | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface InitializeHandlerArguments<Input>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface InitializeHandlerArguments<Input extends object> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              input: Input;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Input extends object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          input: Input

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          User input to a command. Reflects the userland representation of the union of data types the command can effectively handle.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.InitializeHandlerOutput.html b/docs/interfaces/_internal_.InitializeHandlerOutput.html index 038d921a..bfc590df 100644 --- a/docs/interfaces/_internal_.InitializeHandlerOutput.html +++ b/docs/interfaces/_internal_.InitializeHandlerOutput.html @@ -1,4 +1,4 @@ -InitializeHandlerOutput | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface InitializeHandlerOutput<Output>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface InitializeHandlerOutput<Output extends object> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                output: Output;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                response: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Output extends object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            output +InitializeHandlerOutput | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface InitializeHandlerOutput<Output>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface InitializeHandlerOutput<Output extends object> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  output: Output;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  response: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Output extends object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              output response

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              output: Output
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              response: unknown

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              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 diff --git a/docs/interfaces/_internal_.LicenseObject.html b/docs/interfaces/_internal_.LicenseObject.html index eac29a3f..1470c6a8 100644 --- a/docs/interfaces/_internal_.LicenseObject.html +++ b/docs/interfaces/_internal_.LicenseObject.html @@ -1,4 +1,4 @@ -LicenseObject | ts-lambda-api - v2.5.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface LicenseObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface LicenseObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    identifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    url?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                identifier? +LicenseObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface LicenseObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface LicenseObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      identifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      url?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  identifier? name url?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  identifier?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  url?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.LinkObject.html b/docs/interfaces/_internal_.LinkObject.html index 883eebc6..b5b10b33 100644 --- a/docs/interfaces/_internal_.LinkObject.html +++ b/docs/interfaces/_internal_.LinkObject.html @@ -1,4 +1,4 @@ -LinkObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface LinkObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface LinkObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        operationId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        operationRef?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        parameters?: LinkParametersObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requestBody?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        server?: ServerObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [property: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [property: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description? +LinkObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface LinkObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface LinkObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          operationId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          operationRef?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          parameters?: LinkParametersObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          requestBody?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          server?: ServerObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [property: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [property: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      description? operationId? operationRef? parameters? diff --git a/docs/interfaces/_internal_.ListSchema.html b/docs/interfaces/_internal_.ListSchema.html index 6c6f8320..19c50faa 100644 --- a/docs/interfaces/_internal_.ListSchema.html +++ b/docs/interfaces/_internal_.ListSchema.html @@ -1,6 +1,6 @@ ListSchema | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ListSchemaInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Schema for the list aggregate type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        use static schema.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ListSchema {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            namespace: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            traits: SchemaTraits;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            valueSchema: SchemaRef;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ListSchema {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            namespace: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            traits: SchemaTraits;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            valueSchema: SchemaRef;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name namespace traits valueSchema diff --git a/docs/interfaces/_internal_.MapSchema.html b/docs/interfaces/_internal_.MapSchema.html index 940d9b33..00c3a7e4 100644 --- a/docs/interfaces/_internal_.MapSchema.html +++ b/docs/interfaces/_internal_.MapSchema.html @@ -1,6 +1,6 @@ MapSchema | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface MapSchemaInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Schema for the map aggregate type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          use static schema.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface MapSchema {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keySchema: SchemaRef;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              namespace: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              traits: SchemaTraits;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              valueSchema: SchemaRef;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          keySchema +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface MapSchema {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              keySchema: SchemaRef;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              namespace: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              traits: SchemaTraits;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              valueSchema: SchemaRef;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          keySchema name namespace traits diff --git a/docs/interfaces/_internal_.MediaTypeObject.html b/docs/interfaces/_internal_.MediaTypeObject.html index bf8ac148..322f72b0 100644 --- a/docs/interfaces/_internal_.MediaTypeObject.html +++ b/docs/interfaces/_internal_.MediaTypeObject.html @@ -1,4 +1,4 @@ -MediaTypeObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface MediaTypeObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface MediaTypeObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                encoding?: EncodingObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                example?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                examples?: ExamplesObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            encoding? +MediaTypeObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface MediaTypeObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface MediaTypeObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  encoding?: EncodingObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  example?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  examples?: ExamplesObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              encoding? example? examples? schema? diff --git a/docs/interfaces/_internal_.MoveOperation.html b/docs/interfaces/_internal_.MoveOperation.html index 5d061712..f2d4451d 100644 --- a/docs/interfaces/_internal_.MoveOperation.html +++ b/docs/interfaces/_internal_.MoveOperation.html @@ -1,4 +1,4 @@ -MoveOperation | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface MoveOperation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface MoveOperation {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    from: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    op: "move";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                from +MoveOperation | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface MoveOperation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface MoveOperation {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      from: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      op: "move";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  from op path

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  from: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  op: "move"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  path: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.MultipleOptionalResolvedValueMetadataInjectOptions.html b/docs/interfaces/_internal_.MultipleOptionalResolvedValueMetadataInjectOptions.html index 426de929..d90aff70 100644 --- a/docs/interfaces/_internal_.MultipleOptionalResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.MultipleOptionalResolvedValueMetadataInjectOptions.html @@ -1,4 +1,4 @@ -MultipleOptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface MultipleOptionalResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface MultipleOptionalResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        chained?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isMultiple: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        optional: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    chained? +MultipleOptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface MultipleOptionalResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface MultipleOptionalResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          chained?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isMultiple: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          optional: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      chained? isMultiple name? optional diff --git a/docs/interfaces/_internal_.MultipleResolvedValueMetadataInjectOptions.html b/docs/interfaces/_internal_.MultipleResolvedValueMetadataInjectOptions.html index f8be0a8c..422662de 100644 --- a/docs/interfaces/_internal_.MultipleResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.MultipleResolvedValueMetadataInjectOptions.html @@ -1,4 +1,4 @@ -MultipleResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface MultipleResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface MultipleResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            chained?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            isMultiple: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        chained? +MultipleResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface MultipleResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface MultipleResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              chained?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              isMultiple: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          chained? isMultiple name? serviceIdentifier diff --git a/docs/interfaces/_internal_.OAuthFlowObject.html b/docs/interfaces/_internal_.OAuthFlowObject.html index 584fa1ec..2b7658dc 100644 --- a/docs/interfaces/_internal_.OAuthFlowObject.html +++ b/docs/interfaces/_internal_.OAuthFlowObject.html @@ -1,4 +1,4 @@ -OAuthFlowObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface OAuthFlowObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface OAuthFlowObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                authorizationUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                refreshUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                scopes: ScopesObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tokenUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            authorizationUrl? +OAuthFlowObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface OAuthFlowObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface OAuthFlowObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  authorizationUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  refreshUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  scopes: ScopesObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tokenUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              authorizationUrl? refreshUrl? scopes tokenUrl? diff --git a/docs/interfaces/_internal_.OAuthFlowsObject.html b/docs/interfaces/_internal_.OAuthFlowsObject.html index cd2bf934..4df59182 100644 --- a/docs/interfaces/_internal_.OAuthFlowsObject.html +++ b/docs/interfaces/_internal_.OAuthFlowsObject.html @@ -1,4 +1,4 @@ -OAuthFlowsObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface OAuthFlowsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface OAuthFlowsObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    authorizationCode?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    clientCredentials?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    implicit?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    password?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                authorizationCode? +OAuthFlowsObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface OAuthFlowsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface OAuthFlowsObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      authorizationCode?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      clientCredentials?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      implicit?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      password?: OAuthFlowObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  authorizationCode? clientCredentials? implicit? password? diff --git a/docs/interfaces/_internal_.OpenAPIObject.html b/docs/interfaces/_internal_.OpenAPIObject.html index ab0997fc..22b568e1 100644 --- a/docs/interfaces/_internal_.OpenAPIObject.html +++ b/docs/interfaces/_internal_.OpenAPIObject.html @@ -1,4 +1,4 @@ -OpenAPIObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface OpenAPIObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface OpenAPIObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        components?: ComponentsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        externalDocs?: ExternalDocumentationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        info: InfoObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        openapi: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        paths?: PathsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        security?: SecurityRequirementObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        servers?: ServerObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tags?: TagObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        webhooks?: PathsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    components? +OpenAPIObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface OpenAPIObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface OpenAPIObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          components?: ComponentsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          externalDocs?: ExternalDocumentationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          info: InfoObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          openapi: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          paths?: PathsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          security?: SecurityRequirementObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          servers?: ServerObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tags?: TagObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          webhooks?: PathsObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      components? externalDocs? info openapi diff --git a/docs/interfaces/_internal_.OperationObject.html b/docs/interfaces/_internal_.OperationObject.html index abe19570..e6062067 100644 --- a/docs/interfaces/_internal_.OperationObject.html +++ b/docs/interfaces/_internal_.OperationObject.html @@ -1,4 +1,4 @@ -OperationObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface OperationObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface OperationObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            callbacks?: CallbacksObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            externalDocs?: ExternalDocumentationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            operationId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            parameters?: (ReferenceObject | ParameterObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            requestBody?: ReferenceObject | RequestBodyObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            responses?: ResponsesObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            security?: SecurityRequirementObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            servers?: ServerObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            summary?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tags?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callbacks? +OperationObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface OperationObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface OperationObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              callbacks?: CallbacksObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              externalDocs?: ExternalDocumentationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              operationId?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              parameters?: (ReferenceObject | ParameterObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              requestBody?: ReferenceObject | RequestBodyObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              responses?: ResponsesObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              security?: SecurityRequirementObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              servers?: ServerObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              summary?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              tags?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          callbacks? deprecated? description? externalDocs? diff --git a/docs/interfaces/_internal_.OptionalGetOptions.html b/docs/interfaces/_internal_.OptionalGetOptions.html index e3f9adff..7f94abbc 100644 --- a/docs/interfaces/_internal_.OptionalGetOptions.html +++ b/docs/interfaces/_internal_.OptionalGetOptions.html @@ -1,4 +1,4 @@ -OptionalGetOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface OptionalGetOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface OptionalGetOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                autobind?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                optional: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tag?: GetOptionsTagConstraint;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            autobind? +OptionalGetOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface OptionalGetOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface OptionalGetOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  autobind?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  optional: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tag?: GetOptionsTagConstraint;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              autobind? name? optional tag? diff --git a/docs/interfaces/_internal_.OptionalResolvedValueMetadataInjectOptions.html b/docs/interfaces/_internal_.OptionalResolvedValueMetadataInjectOptions.html index 0f5bc29d..742dd252 100644 --- a/docs/interfaces/_internal_.OptionalResolvedValueMetadataInjectOptions.html +++ b/docs/interfaces/_internal_.OptionalResolvedValueMetadataInjectOptions.html @@ -1,4 +1,4 @@ -OptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface OptionalResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface OptionalResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    optional: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name? +OptionalResolvedValueMetadataInjectOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface OptionalResolvedValueMetadataInjectOptions<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface OptionalResolvedValueMetadataInjectOptions<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name?: MetadataName;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      optional: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      serviceIdentifier: ServiceIdentifier<T> | LazyServiceIdentifier<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tags?: ResolvedValueMetadataInjectTagOptions[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name? optional serviceIdentifier tags? diff --git a/docs/interfaces/_internal_.OutgoingHttpHeaders.html b/docs/interfaces/_internal_.OutgoingHttpHeaders.html index c77682e4..7a916a92 100644 --- a/docs/interfaces/_internal_.OutgoingHttpHeaders.html +++ b/docs/interfaces/_internal_.OutgoingHttpHeaders.html @@ -1,4 +1,4 @@ -OutgoingHttpHeaders | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface OutgoingHttpHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface OutgoingHttpHeaders {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accept?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "accept-charset"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "accept-encoding"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "accept-language"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "accept-ranges"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-allow-credentials"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-allow-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-allow-methods"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-allow-origin"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-expose-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-max-age"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-request-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "access-control-request-method"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        age?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allow?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        authorization?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "cache-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "cdn-cache-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        connection?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-disposition"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-language"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-length"?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-location"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-range"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-security-policy"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-security-policy-report-only"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "content-type"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cookie?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        date?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        dav?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        dnt?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        etag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        expect?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        expires?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        forwarded?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        from?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "if-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "if-modified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "if-none-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "if-range"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "if-unmodified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "last-modified"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        link?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        location?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "max-forwards"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        origin?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pragma?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "proxy-authenticate"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "proxy-authorization"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "public-key-pins"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "public-key-pins-report-only"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        range?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        referer?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "referrer-policy"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        refresh?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "retry-after"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "sec-websocket-accept"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "sec-websocket-extensions"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "sec-websocket-key"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "sec-websocket-protocol"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "sec-websocket-version"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        server?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "set-cookie"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "strict-transport-security"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        te?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        trailer?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "transfer-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        upgrade?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "upgrade-insecure-requests"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "user-agent"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        vary?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        via?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        warning?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "www-authenticate"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "x-content-type-options"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "x-dns-prefetch-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "x-frame-options"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "x-xss-protection"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [key: string]: OutgoingHttpHeader;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    accept? +OutgoingHttpHeaders | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface OutgoingHttpHeaders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface OutgoingHttpHeaders {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          accept?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "accept-charset"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "accept-encoding"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "accept-language"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "accept-ranges"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-allow-credentials"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-allow-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-allow-methods"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-allow-origin"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-expose-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-max-age"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-request-headers"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "access-control-request-method"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          age?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allow?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          authorization?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "cache-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "cdn-cache-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          connection?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-disposition"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-language"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-length"?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-location"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-range"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-security-policy"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-security-policy-report-only"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "content-type"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cookie?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          date?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          dav?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          dnt?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          etag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          expect?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          expires?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          forwarded?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          from?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "if-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "if-modified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "if-none-match"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "if-range"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "if-unmodified-since"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "last-modified"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          link?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          location?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "max-forwards"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          origin?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pragma?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "proxy-authenticate"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "proxy-authorization"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "public-key-pins"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "public-key-pins-report-only"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          range?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          referer?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "referrer-policy"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          refresh?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "retry-after"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "sec-websocket-accept"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "sec-websocket-extensions"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "sec-websocket-key"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "sec-websocket-protocol"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "sec-websocket-version"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          server?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "set-cookie"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "strict-transport-security"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          te?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          trailer?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "transfer-encoding"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          upgrade?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "upgrade-insecure-requests"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "user-agent"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          vary?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          via?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          warning?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "www-authenticate"?: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "x-content-type-options"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "x-dns-prefetch-control"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "x-frame-options"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "x-xss-protection"?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [key: string]: OutgoingHttpHeader;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      accept? accept-charset? accept-encoding? accept-language? diff --git a/docs/interfaces/_internal_.ParameterObject.html b/docs/interfaces/_internal_.ParameterObject.html index 269991d5..f40637d7 100644 --- a/docs/interfaces/_internal_.ParameterObject.html +++ b/docs/interfaces/_internal_.ParameterObject.html @@ -1,4 +1,4 @@ -ParameterObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ParameterObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ParameterObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            allowEmptyValue?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            allowReserved?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            content?: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            example?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            examples?: { [param: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            explode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            in: ParameterLocation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            required?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            style?: ParameterStyle;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowEmptyValue? +ParameterObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ParameterObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ParameterObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              allowEmptyValue?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              allowReserved?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              content?: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              deprecated?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              example?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              examples?: { [param: string]: ReferenceObject | ExampleObject };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              explode?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              in: ParameterLocation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              required?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              schema?: SchemaObject | ReferenceObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              style?: ParameterStyle;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allowEmptyValue? allowReserved? content? deprecated? diff --git a/docs/interfaces/_internal_.Parsed-1.html b/docs/interfaces/_internal_.Parsed-1.html index e3c93a4c..e0fec7ae 100644 --- a/docs/interfaces/_internal_.Parsed-1.html +++ b/docs/interfaces/_internal_.Parsed-1.html @@ -1,4 +1,4 @@ -Parsed | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface Parsed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface Parsed {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                anchor?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                format?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                minFractionDigits?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                source: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                srcToken?: FlowScalar | BlockScalar;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type?: Type;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                value: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                clone(): NodeBase;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                toJSON(arg?: any, ctx?: ToJSContext): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                toString(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [NODE_TYPE] +Parsed | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface Parsed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface Parsed {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  anchor?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  format?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  minFractionDigits?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  source: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  srcToken?: FlowScalar | BlockScalar;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type?: Type;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  clone(): NodeBase;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  toJSON(arg?: any, ctx?: ToJSContext): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  toString(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [NODE_TYPE] addToJSMap? anchor? comment? diff --git a/docs/interfaces/_internal_.Parsed-2.html b/docs/interfaces/_internal_.Parsed-2.html index fe137720..90825677 100644 --- a/docs/interfaces/_internal_.Parsed-2.html +++ b/docs/interfaces/_internal_.Parsed-2.html @@ -1,4 +1,4 @@ -Parsed | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface Parsed<K, V>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface Parsed<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    K extends ParsedNode = ParsedNode,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    V extends ParsedNode | null = ParsedNode | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                > {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    anchor?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    flow?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    items: Pair<K, V>[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    schema: Schema;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    srcToken?: BlockMap | FlowCollection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    add(pair: Pair<K, V> | { key: K; value: V }, overwrite?: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    clone(schema?: Schema): Collection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    delete(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    get(key: unknown, keepScalar: true): Scalar<V>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    get(key: unknown, keepScalar?: false): V;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    get(key: unknown, keepScalar?: boolean): V | Scalar<V>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getIn(path: Iterable<unknown>, keepScalar?: boolean): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    has(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hasAllNullValues(allowScalar?: boolean): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hasIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    set(key: K, value: V): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toJSON<T extends MapLike = Map<unknown, unknown>>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _?: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ctx?: ToJSContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type?: new () => T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    toString(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ctx?: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [NODE_TYPE] +Parsed | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface Parsed<K, V>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface Parsed<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      K extends ParsedNode = ParsedNode,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      V extends ParsedNode | null = ParsedNode | null,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  > {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      anchor?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      flow?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      items: Pair<K, V>[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      schema: Schema;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      srcToken?: BlockMap | FlowCollection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      add(pair: Pair<K, V> | { key: K; value: V }, overwrite?: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      addIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      clone(schema?: Schema): Collection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      delete(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      get(key: unknown, keepScalar: true): Scalar<V>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      get(key: unknown, keepScalar?: false): V;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      get(key: unknown, keepScalar?: boolean): V | Scalar<V>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getIn(path: Iterable<unknown>, keepScalar?: boolean): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      has(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hasAllNullValues(allowScalar?: boolean): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hasIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      set(key: K, value: V): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      toJSON<T extends MapLike = Map<unknown, unknown>>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          _?: unknown,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ctx?: ToJSContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type?: new () => T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      toString(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ctx?: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [NODE_TYPE] addToJSMap? anchor? comment? diff --git a/docs/interfaces/_internal_.Parsed-3.html b/docs/interfaces/_internal_.Parsed-3.html index bf7792f6..67266b4c 100644 --- a/docs/interfaces/_internal_.Parsed-3.html +++ b/docs/interfaces/_internal_.Parsed-3.html @@ -1,4 +1,4 @@ -Parsed | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface Parsed<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface Parsed<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        T extends ParsedNode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Pair<ParsedNode, ParsedNode | null> = ParsedNode,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    > {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        anchor?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        flow?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        items: T[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        schema: Schema;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        srcToken?: BlockSequence | FlowCollection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        add(value: T): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        addIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clone(schema?: Schema): Collection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        delete(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        get(key: unknown, keepScalar: true): Scalar<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        get(key: unknown, keepScalar?: false): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        get(key: unknown, keepScalar?: boolean): T | Scalar<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getIn(path: Iterable<unknown>, keepScalar?: boolean): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        has(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hasAllNullValues(allowScalar?: boolean): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hasIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        set(key: unknown, value: T): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        toJSON(_?: unknown, ctx?: ToJSContext): unknown[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        toString(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ctx?: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [NODE_TYPE] +Parsed | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface Parsed<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface Parsed<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          T extends ParsedNode
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Pair<ParsedNode, ParsedNode | null> = ParsedNode,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      > {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          anchor?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          flow?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          items: T[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          schema: Schema;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          srcToken?: BlockSequence | FlowCollection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          add(value: T): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          addIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clone(schema?: Schema): Collection;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          delete(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          get(key: unknown, keepScalar: true): Scalar<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          get(key: unknown, keepScalar?: false): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          get(key: unknown, keepScalar?: boolean): T | Scalar<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getIn(path: Iterable<unknown>, keepScalar?: boolean): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          has(key: unknown): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hasAllNullValues(allowScalar?: boolean): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hasIn(path: Iterable<unknown>): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          set(key: unknown, value: T): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          setIn(path: Iterable<unknown>, value: unknown): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          toJSON(_?: unknown, ctx?: ToJSContext): unknown[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          toString(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ctx?: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [NODE_TYPE] addToJSMap? anchor? comment? diff --git a/docs/interfaces/_internal_.Parsed.html b/docs/interfaces/_internal_.Parsed.html index dc7b5374..c035bfbd 100644 --- a/docs/interfaces/_internal_.Parsed.html +++ b/docs/interfaces/_internal_.Parsed.html @@ -1,4 +1,4 @@ -Parsed | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface Parsed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface Parsed {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            anchor?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            source: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            srcToken?: FlowScalar & { type: "alias" };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            clone(): NodeBase;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resolve(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                doc: Document,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ctx?: ToJSContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Scalar<unknown> | YAMLMap<unknown, unknown> | YAMLSeq<unknown>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            toJSON(_arg?: unknown, ctx?: ToJSContext): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            toString(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ctx?: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                _onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                _onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [NODE_TYPE] +Parsed | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface Parsed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface Parsed {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "[NODE_TYPE]": symbol;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              addToJSMap?: (ctx: ToJSContext, map: MapLike, value: unknown) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              anchor?: never;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              comment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              commentBefore?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              range: Range;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              source: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              spaceBefore?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              srcToken?: FlowScalar & { type: "alias" };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              tag?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              clone(): NodeBase;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resolve(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  doc: Document,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ctx?: ToJSContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Scalar<unknown> | YAMLMap<unknown, unknown> | YAMLSeq<unknown>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              toJS(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  doc: Document<Node<unknown>, boolean>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  __namedParameters?: ToJSOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              toJSON(_arg?: unknown, ctx?: ToJSContext): unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              toString(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ctx?: StringifyContext,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  _onComment?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  _onChompKeep?: () => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [NODE_TYPE] addToJSMap? anchor? comment? diff --git a/docs/interfaces/_internal_.PathItemObject.html b/docs/interfaces/_internal_.PathItemObject.html index 4adfbd69..5eaac129 100644 --- a/docs/interfaces/_internal_.PathItemObject.html +++ b/docs/interfaces/_internal_.PathItemObject.html @@ -1,4 +1,4 @@ -PathItemObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface PathItemObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface PathItemObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                $ref?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                delete?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                get?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                head?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                options?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                parameters?: (ReferenceObject | ParameterObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                patch?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                post?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                put?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                servers?: ServerObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                summary?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                trace?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            $ref? +PathItemObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface PathItemObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface PathItemObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  $ref?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  delete?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  get?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  head?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  parameters?: (ReferenceObject | ParameterObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  patch?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  post?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  put?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  servers?: ServerObject[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  summary?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  trace?: OperationObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              $ref? delete? description? get? diff --git a/docs/interfaces/_internal_.PathsObject.html b/docs/interfaces/_internal_.PathsObject.html index 5304d82a..eaee727b 100644 --- a/docs/interfaces/_internal_.PathsObject.html +++ b/docs/interfaces/_internal_.PathsObject.html @@ -1 +1 @@ -PathsObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface PathsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +PathsObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface PathsObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/_internal_.PeerCertificate.html b/docs/interfaces/_internal_.PeerCertificate.html index eea86b11..a2851eab 100644 --- a/docs/interfaces/_internal_.PeerCertificate.html +++ b/docs/interfaces/_internal_.PeerCertificate.html @@ -1,4 +1,4 @@ -PeerCertificate | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface PeerCertificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface PeerCertificate {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        asn1Curve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        bits?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ca: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exponent?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ext_key_usage?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fingerprint: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fingerprint256: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fingerprint512: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        infoAccess?: Dict<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        issuer: Certificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        modulus?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        nistCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pubkey?: NonSharedBuffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        raw: NonSharedBuffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serialNumber: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        subject: Certificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        subjectaltname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        valid_from: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        valid_to: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    asn1Curve? +PeerCertificate | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface PeerCertificate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface PeerCertificate {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          asn1Curve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          bits?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ca: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exponent?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ext_key_usage?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fingerprint: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fingerprint256: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fingerprint512: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          infoAccess?: Dict<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          issuer: Certificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          modulus?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          nistCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pubkey?: NonSharedBuffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          raw: NonSharedBuffer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          serialNumber: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          subject: Certificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          subjectaltname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          valid_from: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          valid_to: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      asn1Curve? bits? ca exponent? diff --git a/docs/interfaces/_internal_.ProcessEnv.html b/docs/interfaces/_internal_.ProcessEnv.html index 34eabe53..5b937a60 100644 --- a/docs/interfaces/_internal_.ProcessEnv.html +++ b/docs/interfaces/_internal_.ProcessEnv.html @@ -1 +1 @@ -ProcessEnv | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ProcessEnv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [key: string]: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +ProcessEnv | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ProcessEnv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [key: string]: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/_internal_.ProxyEnv.html b/docs/interfaces/_internal_.ProxyEnv.html index 39bb7f24..c3fc15eb 100644 --- a/docs/interfaces/_internal_.ProxyEnv.html +++ b/docs/interfaces/_internal_.ProxyEnv.html @@ -1,4 +1,4 @@ -ProxyEnv | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ProxyEnv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ProxyEnv {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                http_proxy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                HTTP_PROXY?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                https_proxy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                HTTPS_PROXY?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                no_proxy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                NO_PROXY?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [key: string]: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [key: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            http_proxy? +ProxyEnv | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface ProxyEnv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface ProxyEnv {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  http_proxy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  HTTP_PROXY?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  https_proxy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  HTTPS_PROXY?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  no_proxy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  NO_PROXY?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [key: string]: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [key: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              http_proxy? HTTP_PROXY? https_proxy? HTTPS_PROXY? diff --git a/docs/interfaces/_internal_.ReadWriteStream.html b/docs/interfaces/_internal_.ReadWriteStream.html index 00648d22..41ddd2d8 100644 --- a/docs/interfaces/_internal_.ReadWriteStream.html +++ b/docs/interfaces/_internal_.ReadWriteStream.html @@ -1,4 +1,4 @@ -ReadWriteStream | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface ReadWriteStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface ReadWriteStream {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    writable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "[asyncIterator]"(): AsyncIterableIterator<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Buffer<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    >;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    "[captureRejectionSymbol]"?<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        event: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ...args: AnyRest,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    emit<K>(eventName: string | symbol, ...args: AnyRest): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    end(cb?: () => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    end(data: string | Uint8Array<ArrayBufferLike>, cb?: () => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    end(str: string, encoding?: BufferEncoding, cb?: () => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    eventNames(): (string | symbol)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getMaxListeners(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    isPaused(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    listenerCount<K>(eventName: string | symbol, listener?: Function): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    listeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    off<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    on<K>(eventName: string | symbol, listener: (...args: any[]) => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    once<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pause(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pipe<T extends WritableStream>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        destination: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: { end?: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prependListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    prependOnceListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    rawListeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    read(size?: number): string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    removeAllListeners(eventName?: string | symbol): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    removeListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resume(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setEncoding(encoding: BufferEncoding): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setMaxListeners(n: number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    unpipe(destination?: WritableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    unshift(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        chunk: string | Uint8Array<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        encoding?: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    wrap(oldStream: ReadableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    write(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        buffer: string | Uint8Array<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cb?: (err?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    write(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        str: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        encoding?: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cb?: (err?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readable +ReadWriteStream | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface ReadWriteStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface ReadWriteStream {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      writable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "[asyncIterator]"(): AsyncIterableIterator<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Buffer<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      >;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "[captureRejectionSymbol]"?<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          event: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ...args: AnyRest,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      addListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      emit<K>(eventName: string | symbol, ...args: AnyRest): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      end(cb?: () => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      end(data: string | Uint8Array<ArrayBufferLike>, cb?: () => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      end(str: string, encoding?: BufferEncoding, cb?: () => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      eventNames(): (string | symbol)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getMaxListeners(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      isPaused(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      listenerCount<K>(eventName: string | symbol, listener?: Function): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      listeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      off<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      on<K>(eventName: string | symbol, listener: (...args: any[]) => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      once<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pause(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pipe<T extends WritableStream>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          destination: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: { end?: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      prependListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      prependOnceListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      rawListeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      read(size?: number): string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      removeAllListeners(eventName?: string | symbol): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      removeListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resume(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setEncoding(encoding: BufferEncoding): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setMaxListeners(n: number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      unpipe(destination?: WritableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      unshift(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          chunk: string | Uint8Array<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          encoding?: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      wrap(oldStream: ReadableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      write(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          buffer: string | Uint8Array<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cb?: (err?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      write(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          str: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          encoding?: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cb?: (err?: Error) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readable writable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [asyncIterator] [captureRejectionSymbol]? diff --git a/docs/interfaces/_internal_.ReadableStream.html b/docs/interfaces/_internal_.ReadableStream.html index cc750496..21bb695e 100644 --- a/docs/interfaces/_internal_.ReadableStream.html +++ b/docs/interfaces/_internal_.ReadableStream.html @@ -1,4 +1,4 @@ -ReadableStream | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface ReadableStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface ReadableStream {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "[asyncIterator]"(): AsyncIterableIterator<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        >;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        "[captureRejectionSymbol]"?<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            event: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ...args: AnyRest,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        addListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        emit<K>(eventName: string | symbol, ...args: AnyRest): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        eventNames(): (string | symbol)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getMaxListeners(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isPaused(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listenerCount<K>(eventName: string | symbol, listener?: Function): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        listeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        off<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        on<K>(eventName: string | symbol, listener: (...args: any[]) => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        once<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pause(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pipe<T extends WritableStream>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            destination: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: { end?: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        prependListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        prependOnceListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rawListeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        read(size?: number): string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        removeAllListeners(eventName?: string | symbol): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        removeListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        resume(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setEncoding(encoding: BufferEncoding): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setMaxListeners(n: number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        unpipe(destination?: WritableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        unshift(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            chunk: string | Uint8Array<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            encoding?: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        wrap(oldStream: ReadableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readable +ReadableStream | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface ReadableStream

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface ReadableStream {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readable: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[asyncIterator]"(): AsyncIterableIterator<
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Buffer<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          >;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          "[captureRejectionSymbol]"?<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              error: Error,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              event: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ...args: AnyRest,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          addListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          emit<K>(eventName: string | symbol, ...args: AnyRest): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          eventNames(): (string | symbol)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getMaxListeners(): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isPaused(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listenerCount<K>(eventName: string | symbol, listener?: Function): number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          listeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          off<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          on<K>(eventName: string | symbol, listener: (...args: any[]) => void): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          once<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pause(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pipe<T extends WritableStream>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              destination: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: { end?: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          prependListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          prependOnceListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          rawListeners<K>(eventName: string | symbol): Function[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          read(size?: number): string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          removeAllListeners(eventName?: string | symbol): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          removeListener<K>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              eventName: string | symbol,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              listener: (...args: any[]) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          resume(): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          setEncoding(encoding: BufferEncoding): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          setMaxListeners(n: number): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          unpipe(destination?: WritableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          unshift(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              chunk: string | Uint8Array<ArrayBufferLike>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              encoding?: BufferEncoding,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          wrap(oldStream: ReadableStream): this;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [asyncIterator] [captureRejectionSymbol]? addListener diff --git a/docs/interfaces/_internal_.ReadableStreamAsyncIterator.html b/docs/interfaces/_internal_.ReadableStreamAsyncIterator.html index 5779f97c..95df8e4a 100644 --- a/docs/interfaces/_internal_.ReadableStreamAsyncIterator.html +++ b/docs/interfaces/_internal_.ReadableStreamAsyncIterator.html @@ -1,4 +1,4 @@ -ReadableStreamAsyncIterator | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface ReadableStreamAsyncIterator<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface ReadableStreamAsyncIterator<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[asyncDispose]"(): PromiseLike<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            "[asyncIterator]"(): ReadableStreamAsyncIterator<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            next(...__namedParameters: [] | [unknown]): Promise<IteratorResult<T, any>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            return?(value?: any): Promise<IteratorResult<T, any>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throw?(e?: any): Promise<IteratorResult<T, any>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [asyncDispose] +ReadableStreamAsyncIterator | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ReadableStreamAsyncIterator<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ReadableStreamAsyncIterator<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "[asyncDispose]"(): PromiseLike<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              "[asyncIterator]"(): ReadableStreamAsyncIterator<T>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              next(...__namedParameters: [] | [unknown]): Promise<IteratorResult<T, any>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              return?(value?: any): Promise<IteratorResult<T, any>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              throw?(e?: any): Promise<IteratorResult<T, any>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [asyncDispose] [asyncIterator] next return? diff --git a/docs/interfaces/_internal_.ReadableStreamBYOBReader.html b/docs/interfaces/_internal_.ReadableStreamBYOBReader.html index 094bb8a8..c1bd46b7 100644 --- a/docs/interfaces/_internal_.ReadableStreamBYOBReader.html +++ b/docs/interfaces/_internal_.ReadableStreamBYOBReader.html @@ -1,5 +1,5 @@ ReadableStreamBYOBReader | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ReadableStreamBYOBReader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            MDN Reference

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ReadableStreamBYOBReader {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                closed: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cancel(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                read<T extends ArrayBufferView<ArrayBufferLike>>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    view: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: { min?: number },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ReadableStreamReadResult<T>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                releaseLock(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            closed +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ReadableStreamBYOBReader {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                closed: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cancel(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                read<T extends ArrayBufferView<ArrayBufferLike>>(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    view: T,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: { min?: number },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ReadableStreamReadResult<T>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                releaseLock(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            closed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cancel read releaseLock diff --git a/docs/interfaces/_internal_.ReadableStreamDefaultReader.html b/docs/interfaces/_internal_.ReadableStreamDefaultReader.html index c550e3cf..e177fab7 100644 --- a/docs/interfaces/_internal_.ReadableStreamDefaultReader.html +++ b/docs/interfaces/_internal_.ReadableStreamDefaultReader.html @@ -1,4 +1,4 @@ -ReadableStreamDefaultReader | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface ReadableStreamDefaultReader<R>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface ReadableStreamDefaultReader<R = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  closed: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cancel(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  read(): Promise<ReadableStreamReadResult<R>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  releaseLock(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • R = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              closed +ReadableStreamDefaultReader | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface ReadableStreamDefaultReader<R>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface ReadableStreamDefaultReader<R = any> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    closed: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cancel(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    read(): Promise<ReadableStreamReadResult<R>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    releaseLock(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • R = any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                closed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cancel read releaseLock diff --git a/docs/interfaces/_internal_.ReadableStreamGenericReader.html b/docs/interfaces/_internal_.ReadableStreamGenericReader.html index e308869c..4595bb63 100644 --- a/docs/interfaces/_internal_.ReadableStreamGenericReader.html +++ b/docs/interfaces/_internal_.ReadableStreamGenericReader.html @@ -1,3 +1,3 @@ -ReadableStreamGenericReader | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface ReadableStreamGenericReader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface ReadableStreamGenericReader {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      closed: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cancel(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  closed +ReadableStreamGenericReader | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface ReadableStreamGenericReader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface ReadableStreamGenericReader {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        closed: Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cancel(reason?: any): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    closed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cancel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    closed: Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Optionalreason: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/docs/interfaces/_internal_.RemoveOperation.html b/docs/interfaces/_internal_.RemoveOperation.html index e1e630ee..e9e69fae 100644 --- a/docs/interfaces/_internal_.RemoveOperation.html +++ b/docs/interfaces/_internal_.RemoveOperation.html @@ -1,3 +1,3 @@ -RemoveOperation | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface RemoveOperation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface RemoveOperation {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          op: "remove";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      op +RemoveOperation | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface RemoveOperation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface RemoveOperation {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            op: "remove";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        op path

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        op: "remove"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/interfaces/_internal_.ReplaceOperation.html b/docs/interfaces/_internal_.ReplaceOperation.html index db9ca037..bf2d9891 100644 --- a/docs/interfaces/_internal_.ReplaceOperation.html +++ b/docs/interfaces/_internal_.ReplaceOperation.html @@ -1,4 +1,4 @@ -ReplaceOperation | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ReplaceOperation<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ReplaceOperation<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              op: "replace";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              value: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          op +ReplaceOperation | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ReplaceOperation<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ReplaceOperation<T> {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                op: "replace";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                value: T;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            op path value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            op: "replace"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            path: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            value: T

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/docs/interfaces/_internal_.RequestBodyObject.html b/docs/interfaces/_internal_.RequestBodyObject.html index c46b0923..85cff6e8 100644 --- a/docs/interfaces/_internal_.RequestBodyObject.html +++ b/docs/interfaces/_internal_.RequestBodyObject.html @@ -1,4 +1,4 @@ -RequestBodyObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface RequestBodyObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface RequestBodyObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  content: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  required?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              content +RequestBodyObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface RequestBodyObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface RequestBodyObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    content: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    required?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                content description? required?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                content

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                content: ContentObject
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                required?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.RequestOptions-1.html b/docs/interfaces/_internal_.RequestOptions-1.html index 846445b9..25460271 100644 --- a/docs/interfaces/_internal_.RequestOptions-1.html +++ b/docs/interfaces/_internal_.RequestOptions-1.html @@ -1,5 +1,5 @@ RequestOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface RequestOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  From T, pick a set of properties whose keys are in the union K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface RequestOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      _defaultAgent?: Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      agent?: boolean | Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      auth?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createConnection?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: ClientRequestArgs,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          oncreate: (err: Error, socket: Duplex) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => Duplex;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      defaultPort?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      headers?: readonly string[] | OutgoingHttpHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hostname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      insecureHTTPParser?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      joinDuplicateHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      maxHeaderSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      method?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      port?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setDefaultHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setHost?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      socketPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      uniqueHeaders?: (string | string[])[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  _defaultAgent? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface RequestOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      _defaultAgent?: Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      agent?: boolean | Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      auth?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createConnection?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: ClientRequestArgs,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          oncreate: (err: Error, socket: Duplex) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => Duplex;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      defaultPort?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      headers?: readonly string[] | OutgoingHttpHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      hostname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      insecureHTTPParser?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      joinDuplicateHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      maxHeaderSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      method?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      port?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setDefaultHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setHost?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      socketPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      uniqueHeaders?: (string | string[])[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  _defaultAgent? agent? auth? createConnection? diff --git a/docs/interfaces/_internal_.RequestOptions.html b/docs/interfaces/_internal_.RequestOptions.html index 4725e3fc..f215f13f 100644 --- a/docs/interfaces/_internal_.RequestOptions.html +++ b/docs/interfaces/_internal_.RequestOptions.html @@ -1,5 +1,5 @@ RequestOptions | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Interface RequestOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    From T, pick a set of properties whose keys are in the union K

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface RequestOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _defaultAgent?: Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        agent?: boolean | Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowPartialTrustChain?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        auth?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ca?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cert?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        checkServerIdentity?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            hostname: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cert: DetailedPeerCertificate,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => Error;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ciphers?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientCertEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createConnection?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options: ClientRequestArgs,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            oncreate: (err: Error, socket: Duplex) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => Duplex;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        crl?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultPort?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        dhparam?: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ecdhCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        headers?: readonly string[] | OutgoingHttpHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        honorCipherOrder?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hostname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        insecureHTTPParser?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        joinDuplicateHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike> | KeyObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxHeaderSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        method?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        minVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        passphrase?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike> | PxfObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        port?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        privateKeyEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        privateKeyIdentifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rejectUnauthorized?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secureOptions?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secureProtocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        servername?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sessionIdContext?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sessionTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setDefaultHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setHost?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sigalgs?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        socketPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ticketKeys?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        uniqueHeaders?: (string | string[])[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _defaultAgent? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    interface RequestOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _defaultAgent?: Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        agent?: boolean | Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowPartialTrustChain?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ALPNCallback?: (arg: { protocols: string[]; servername: string }) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        auth?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ca?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cert?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        checkServerIdentity?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            hostname: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cert: DetailedPeerCertificate,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => Error;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ciphers?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientCertEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createConnection?: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options: ClientRequestArgs,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            oncreate: (err: Error, socket: Duplex) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ) => Duplex;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        crl?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike>)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultPort?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        dhparam?: string | Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ecdhCurve?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        family?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        headers?: readonly string[] | OutgoingHttpHeaders;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hints?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        honorCipherOrder?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hostname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        insecureHTTPParser?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        joinDuplicateHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        key?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike> | KeyObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        localAddress?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        localPort?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        lookup?: LookupFunction;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxHeaderSize?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        method?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        minVersion?: SecureVersion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        passphrase?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        path?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pfx?:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Buffer<ArrayBufferLike>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | (string | Buffer<ArrayBufferLike> | PxfObject)[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        port?: string | number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        privateKeyEngine?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        privateKeyIdentifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rejectUnauthorized?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secureOptions?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secureProtocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        servername?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sessionIdContext?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sessionTimeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setDefaultHeaders?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        setHost?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sigalgs?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signal?: AbortSignal;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        socketPath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ticketKeys?: Buffer<ArrayBufferLike>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        timeout?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        uniqueHeaders?: (string | string[])[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    _defaultAgent? agent? allowPartialTrustChain? ALPNCallback? diff --git a/docs/interfaces/_internal_.RequestSigningArguments.html b/docs/interfaces/_internal_.RequestSigningArguments.html index d7e26939..82566e70 100644 --- a/docs/interfaces/_internal_.RequestSigningArguments.html +++ b/docs/interfaces/_internal_.RequestSigningArguments.html @@ -1,4 +1,4 @@ -RequestSigningArguments | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Interface RequestSigningArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      interface RequestSigningArguments {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signableHeaders?: Set<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingDate?: DateInput;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingRegion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signingService?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          unsignableHeaders?: Set<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      signableHeaders? +RequestSigningArguments | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Interface RequestSigningArguments

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        interface RequestSigningArguments {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signableHeaders?: Set<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signingDate?: DateInput;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signingRegion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            signingService?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            unsignableHeaders?: Set<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signableHeaders? signingDate? signingRegion? signingService? diff --git a/docs/interfaces/_internal_.ResponseObject.html b/docs/interfaces/_internal_.ResponseObject.html index 05df56a3..f432263d 100644 --- a/docs/interfaces/_internal_.ResponseObject.html +++ b/docs/interfaces/_internal_.ResponseObject.html @@ -1,4 +1,4 @@ -ResponseObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface ResponseObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface ResponseObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              content?: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              headers?: HeadersObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              links?: LinksObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          content? +ResponseObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Interface ResponseObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            interface ResponseObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                content?: ContentObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                headers?: HeadersObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                links?: LinksObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            content? description headers? links? diff --git a/docs/interfaces/_internal_.ResponsesObject.html b/docs/interfaces/_internal_.ResponsesObject.html index d385dd0e..882671fb 100644 --- a/docs/interfaces/_internal_.ResponsesObject.html +++ b/docs/interfaces/_internal_.ResponsesObject.html @@ -1,2 +1,2 @@ -ResponsesObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Interface ResponsesObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              interface ResponsesObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  default?: ReferenceObject | ResponseObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [statuscode: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [statuscode: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              default? +ResponsesObject | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Interface ResponsesObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                interface ResponsesObject {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    default?: ReferenceObject | ResponseObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [statuscode: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [extensionName: `x-${string}`]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [statuscode: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [extensionName: `x-${string}`]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                default?

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                default?: ReferenceObject | ResponseObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                diff --git a/docs/interfaces/_internal_.RetryStrategyConfiguration.html b/docs/interfaces/_internal_.RetryStrategyConfiguration.html index 7cb7fa9f..c598837e 100644 --- a/docs/interfaces/_internal_.RetryStrategyConfiguration.html +++ b/docs/interfaces/_internal_.RetryStrategyConfiguration.html @@ -1,5 +1,5 @@ RetryStrategyConfiguration | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interface RetryStrategyConfigurationInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A configuration interface with methods called by runtime extension

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface RetryStrategyConfiguration {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      retryStrategy(): Provider<RetryStrategy | RetryStrategyV2>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setRetryStrategy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          retryStrategy: Provider<RetryStrategy | RetryStrategyV2>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  retryStrategy +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  interface RetryStrategyConfiguration {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      retryStrategy(): Provider<RetryStrategy | RetryStrategyV2>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setRetryStrategy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          retryStrategy: Provider<RetryStrategy | RetryStrategyV2>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  retryStrategy setRetryStrategy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/_internal_.Handler.html b/docs/types/_internal_.Handler.html index 4e6a2881..842372b4 100644 --- a/docs/types/_internal_.Handler.html +++ b/docs/types/_internal_.Handler.html @@ -1,4 +1,4 @@ -Handler | ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ts-lambda-api - v2.5.3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Handler<TEvent, TResult>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Handler: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        event: TEvent,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        context: Context,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callback: Callback<TResult>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ) => void | Promise<TResult>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    The interface that AWS Lambda will invoke your handler with. +Handler | ts-lambda-api - v2.5.4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Handler<TEvent, TResult>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Handler: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          event: TEvent,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          context: Context,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          callback: Callback<TResult>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ) => void | Promise<TResult>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      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))
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       })
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/_internal_.OpenApiFormat.html b/docs/types/_internal_.OpenApiFormat.html index d1518839..d582dc93 100644 --- a/docs/types/_internal_.OpenApiFormat.html +++ b/docs/types/_internal_.OpenApiFormat.html @@ -1 +1 @@ -OpenApiFormat | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias OpenApiFormat

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        OpenApiFormat: "json" | "yml"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +OpenApiFormat | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias OpenApiFormat

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OpenApiFormat: "json" | "yml"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/_internal_.ParameterSource.html b/docs/types/_internal_.ParameterSource.html index 78e56d44..5c73ad76 100644 --- a/docs/types/_internal_.ParameterSource.html +++ b/docs/types/_internal_.ParameterSource.html @@ -1 +1 @@ -ParameterSource | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias ParameterSource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ParameterSource: "query" | "header" | "path" | "cookie" | "virtual"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +ParameterSource | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ParameterSource

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ParameterSource: "query" | "header" | "path" | "cookie" | "virtual"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/_internal_.URI.html b/docs/types/_internal_.URI.html index 75fc5db5..12ea194d 100644 --- a/docs/types/_internal_.URI.html +++ b/docs/types/_internal_.URI.html @@ -1,6 +1,6 @@ URI | ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ts-lambda-api - v2.5.4
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias URIInternal

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Represents the components parts of a Uniform Resource Identifier used to construct the target location of a Request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type URI = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    fragment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hostname: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    password?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    port?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    protocol: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    query?: QueryParameterBag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    username?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                fragment? +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type URI = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    fragment?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hostname: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    password?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    path: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    port?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    protocol: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    query?: QueryParameterBag;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    username?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Implemented by

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                fragment? hostname password? path